Skip to content

Commit 1b6b424

Browse files
committed
Specify some sensible validation defaults.
1 parent 39f2f22 commit 1b6b424

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

doc/conf.py

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,18 @@
8686
numpydoc_xref_ignore = {'optional', 'type_without_description', 'BadException'}
8787
# Run docstring validation as part of build process
8888
numpydoc_validate = True
89-
# Report warnings from all build-in validation checks
90-
from numpydoc.validate import ERROR_MSGS
91-
numpydoc_validation_checks = set(ERROR_MSGS.keys())
89+
numpydoc_validation_checks = {
90+
"GL06", # Unknown section name
91+
"GL07", # Sections in wrong order
92+
"GL08", # Object missing docstring
93+
"PR01", # Missing parameters
94+
"PR02", # Unknown parameters
95+
"PR03", # Incorrect parameter ordering
96+
"PR10", # Missing colon between parameter name and type
97+
"RT01", # No returns section
98+
"SA01", # Missing See Also section
99+
"EX01", # Missing Examples section
100+
}
92101

93102
# The language for content autogenerated by Sphinx. Refer to documentation
94103
# for a list of supported languages.

0 commit comments

Comments
 (0)