-
-
Notifications
You must be signed in to change notification settings - Fork 41
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: warn if docstring has extra parameters #63
feat: warn if docstring has extra parameters #63
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey, thanks a lot!
A few suggestions. We also must pass warn_unknown_params=False
from _read_other_parameters
, and add a test to make sure "Other Parameters" sections will not emit warnings.
Co-authored-by: Timothée Mazzucotelli <[email protected]>
I added |
I've split the test in two, to make it more resilient to future possible changes in the warning string: we just check no warnings were emitted. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Thanks again! |
Reference: mkdocstrings/mkdocstrings#408