Sweep: Add documentation for `Assertions`, in `dspy/assert`.

[sweep-ai[bot]]

PR Feedback (click)

• [ ] 👍 Sweep Did Well
• [ ] 👎 Sweep Needs Improvement

  Description

  This pull request adds documentation for the Assertions module in the dspy/assert directory. It introduces new classes and functions related to handling assertions and suggestions in the DSPy framework.

Summary

• Added Suggest class to represent suggestions in the DSPy framework
• Added Constraint class as a base class for Assert and Suggest
• Added noop_handler function to bypass both assertions and suggestions
• Added bypass_suggest_handler function to bypass suggestions only
• Added bypass_assert_handler function to bypass assertions only
• Added assert_no_except_handler function to ignore assertion failures
• Added suggest_backtrack_handler function for backtracking suggestions
• Added handle_assert_forward function to handle assertions
• Added assert_transform_module function to transform a module to handle assertions
• Updated docs/primitives/assertions.md file with the new documentation

Fixes #52.

---

🎉 Latest improvements to Sweep:

• We just released a dashboard to track Sweep's progress on your issue in real-time, showing every stage of the process – from search to planning and coding.
• Sweep uses OpenAI's latest Assistant API to plan code changes and modify code! This is 3x faster and significantly more reliable as it allows Sweep to edit code and validate the changes in tight iterations, the same way as a human would.
• Try using the GitHub issues extension to create Sweep issues directly from your editor! GitHub Issues and Pull Requests.

---

💡 To get Sweep to edit this pull request, you can:

• Comment below, and Sweep can edit the entire PR
• Comment on a file, Sweep will only modify the commented file
• Edit the original issue to get Sweep to recreate the PR from scratch

[sweep-ai[bot]]

Sandbox Executions

[sweep-ai[bot]]

Rollback Files For Sweep

• [ ] Rollback changes to True

[sweep-ai[bot]]

Apply Sweep Rules to your PR?

• [ ] Apply: All new business logic should have corresponding unit tests.
• [ ] Apply: Refactor large functions to be more modular.
• [ ] Apply: Add docstrings to all functions and file headers.
• [ ] Apply: Ensure that any new modules or features adhere to the DSPy framework's syntax and module structure.
• [ ] Apply: Maintain modularity and declarative style as per DSPy's design philosophy.
• [ ] Apply: All new capabilities or changes should be reflected in the documentation docs/.
• [ ] Apply: All documentation should be sphinx-compatible.