Skip to content

Commit e1ff3a5

Browse files
committed
flake8 settings
1 parent 7445ef7 commit e1ff3a5

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

flake8-docstrings.cfg

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[flake8]
2+
# Docstring/signature consistency check (pydoclint as a flake8 plugin).
3+
# Used only by the dedicated CI step via `flake8 --config=flake8-docstrings.cfg`,
4+
# so it does not affect the other flake8 invocations.
5+
#
6+
# Scope is intentionally narrow: enforce only that documented parameters match
7+
# the function signature (names/presence). Type-string and coverage checks are
8+
# left out on purpose (the codebase is partially typed by design, and rendered
9+
# docs take types from the signatures).
10+
select = DOC101,DOC102,DOC103
11+
style = numpy
12+
skip_checking_private_functions = True
13+
ignore_underscore_args = True
14+
ignore_private_args = True
15+
should_document_star_arguments = False

0 commit comments

Comments
 (0)