Skip to content

Commit

Permalink
FIX: Better
Browse files Browse the repository at this point in the history
  • Loading branch information
larsoner committed Nov 18, 2024
1 parent 3c2c8e5 commit c0e4ea8
Showing 1 changed file with 13 additions and 15 deletions.
28 changes: 13 additions & 15 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,21 +118,19 @@
numpydoc_class_members_toctree = False
numpydoc_attributes_as_param_list = True
numpydoc_validate = True
numpydoc_validation_checks = (
{"all"}
| {
# These we do not live by:
"GL01", # Docstring should start in the line immediately after the quotes
"EX01",
"EX02", # examples failed (we test them separately)
"ES01", # no extended summary
"SA01", # no see also
"YD01", # no yields section
"SA04", # no description in See Also
"PR04", # Parameter "shape (n_channels" has no type
"RT02", # The first line of the Returns section should contain only the type, unless multiple values are being returned # noqa
}
)
numpydoc_validation_checks = {
"all",
# These we do not live by:
"GL01", # Docstring should start in the line immediately after the quotes
"EX01",
"EX02", # examples failed (we test them separately)
"ES01", # no extended summary
"SA01", # no see also
"YD01", # no yields section
"SA04", # no description in See Also
"PR04", # Parameter "shape (n_channels" has no type
"RT02", # The first line of the Returns section should contain only the type, unless multiple values are being returned # noqa
}
numpydoc_validation_exclude = { # set of regex
# dict subclasses
r"\.clear",
Expand Down

0 comments on commit c0e4ea8

Please sign in to comment.