Added descriptions for arguments taken from docstring #1825
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
maxisbey
reviewed
Jan 5, 2026
| @contextmanager | ||
| def _disable_griffe_logging(): | ||
| """disables griffe logging""" | ||
| # Hacky, but suggested here: https://github.com/mkdocstrings/griffe/issues/293#issuecomment-2167668117 |
Contributor
There was a problem hiding this comment.
can we not pass in warnings=False as per the last comment in that thread?
maxisbey
added
enhancement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Motivation and Context
This is from issue 226:
#226
We want to add the description of the arguments from the docstring of the function to the jsonschema automatically.
Currently supported docstrings format are:
Google, sphinx, numpy.
How Has This Been Tested?
Previous tests with no docstrings or descriptions in the annotated type pass.
Added tests to make sure code catches the descriptions from all the formats.
Breaking Changes
If a user has a function with a docstring, we will now collect the argument's description.
Types of changes
Checklist
Additional context
Implementation is taken in parts from the similar implementation in pedantic AI