Skip to content

Commit ab81417

Browse files
DaniBodorsjvrijn
authored andcommitted
use ruff docstring convention
more consistent than explicitly ignoring certain rules
1 parent 1af168e commit ab81417

File tree

1 file changed

+6
-15
lines changed

1 file changed

+6
-15
lines changed

{{cookiecutter.directory_name}}/pyproject.toml

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -120,22 +120,13 @@ select = [
120120

121121
]
122122
ignore = [
123-
'D100', # Missing module docstring
124-
'D104', # Missing public package docstring
125-
# The following list excludes rules irrelevant to the Google style
126-
'D203',
127-
'D204',
128-
'D213',
129-
'D215',
130-
'D400',
131-
'D401',
132-
'D404',
133-
'D406',
134-
'D407',
135-
'D408',
136-
'D409',
137-
'D413',
123+
# No docstrings required in the following cases
124+
"D100", # Missing module docstring
125+
"D104", # Missing public package docstring
126+
"D105", # Missing docstring in magic method
127+
"D107", # Missing docstring in `__init__`
138128
]
129+
pydocstyle.convention = "google"
139130

140131
# Allow autofix for all enabled rules (when `--fix`) is provided.
141132
fixable = ["A", "B", "C", "D", "E", "F", "I"]

0 commit comments

Comments
 (0)