the right docstring is added and the schema generation is being tested #818
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR replaces traditional docstrings with JSON schema documentation for the ai functions in both the recipe wrangles and generate modules. The change documents the schema generation process and provides structured metadata for API validation.
- Removes narrative docstrings with code examples
- Adds JSON Schema-formatted documentation within docstrings
- Maintains consistent schema structure across both
recipe_wrangles/generate.pyandgenerate.py
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| wrangles/recipe_wrangles/generate.py | Replaces traditional docstring with JSON schema documentation for the recipe-level ai function |
| wrangles/generate.py | Adds JSON schema documentation to the core ai function |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
the right docstring is added and the schema generation is being tested and the generation process is being documented in the docs