feat[docstrings/sphinx]: Warn when unknown params are in docstring.#210
Merged
pawamoy merged 3 commits intomkdocstrings:mainfrom Nov 11, 2023
Merged
Conversation
Contributor
ashwinvin
commented
Sep 17, 2023
ashwinvin
commented
- Added the feature and test for it
- Closes docstrings/sphinx: Support "warn unknown params" feature #64
Member
|
Thanks! Could you add an option to the Sphinx parser to allow users to enable/disable this behavior? |
Contributor
Author
|
Sure! |
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
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.