Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat[docstrings/sphinx]: Warn when unknown params are in docstring. #210

Merged
merged 3 commits into from
Nov 11, 2023
Merged

feat[docstrings/sphinx]: Warn when unknown params are in docstring. #210

merged 3 commits into from
Nov 11, 2023

Conversation

ashwinvin
Copy link
Contributor

@pawamoy
Copy link
Member

pawamoy commented Sep 18, 2023

Thanks! Could you add an option to the Sphinx parser to allow users to enable/disable this behavior?

@ashwinvin
Copy link
Contributor Author

Sure!

pawamoy
pawamoy approved these changes Nov 11, 2023
View reviewed changes
Copy link
Member

@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM now. Thanks for the PR!

@pawamoy pawamoy merged commit 8b11d77 into mkdocstrings:main Nov 11, 2023
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pawamoy pawamoy pawamoy approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docstrings/sphinx: Support "warn unknown params" feature
2 participants
@ashwinvin @pawamoy