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

Add extra checks in the numpy docstring rules #117

Merged
merged 1 commit into from
Jan 25, 2024
Merged

Add extra checks in the numpy docstring rules #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ checks = [
"GL01", # Contradicts numpydoc examples
"GL02", # Permit a blank line after the end of our docstring
"GL03", # Considering enforcing
"GL06", # Found unknown section
"GL07", # "Sections are in the wrong order. Correct order is: {correct_sections}",
"GL09", # Deprecation warning should precede extended summary (check broken)
"SA01", # Not all docstrings need a see also
"SA04", # See also section does not need descriptions
Expand Down