Skip to content

Commit ea9c61f

Browse files
committed
Add placeholders for pydocstyle (D) in Ruff configuration
1 parent 7213e57 commit ea9c61f

File tree

1 file changed

+46
-1
lines changed

1 file changed

+46
-1
lines changed

.ruff.toml

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,52 @@ select = [
5252
# flake8-copyright ('CPY')
5353
# NOT YET USED
5454
# pydocstyle ('D')
55-
# NOT YET USED
55+
# "D100", # Missing docstring in public module
56+
# "D101", # Missing docstring in public class
57+
# "D102", # Missing docstring in public method
58+
# "D103", # Missing docstring in public function
59+
# "D104", # Missing docstring in public package
60+
# "D105", # Missing docstring in magic method
61+
"D106", # Missing docstring in public nested class
62+
# "D107", # Missing docstring in `__init__`
63+
# "D200", # One-line docstring should fit on one line
64+
"D201", # No blank lines allowed before function docstring (found {num_lines})
65+
# "D202", # No blank lines allowed after function docstring (found {num_lines})
66+
# "D203", # 1 blank line required before class docstring
67+
# "D204", # 1 blank line required after class docstring
68+
# "D205", # 1 blank line required between summary line and description
69+
"D206", # Docstring should be indented with spaces, not tabs
70+
# "D207", # Docstring is under-indented
71+
# "D208", # Docstring is over-indented
72+
# "D209", # Multi-line docstring closing quotes should be on a separate line
73+
# "D210", # No whitespaces allowed surrounding docstring text
74+
"D211", # No blank lines allowed before class docstring
75+
# "D212", # Multi-line docstring summary should start at the first line
76+
# "D213", # Multi-line docstring summary should start at the second line
77+
# "D214", # Section is over-indented ("{name}")
78+
# "D215", # Section underline is over-indented ("{name}")
79+
# "D300", # Use triple double quotes `"""`
80+
# "D301", # Use `r"""` if any backslashes in a docstring
81+
# "D400", # First line should end with a period
82+
# "D401", # First line of docstring should be in imperative mood: "{first_line}"
83+
# "D402", # First line should not be the function's signature
84+
# "D403", # First word of the first line should be capitalized: `{}` -> `{}`
85+
# "D404", # First word of the docstring should not be "This"
86+
"D405", # Section name should be properly capitalized ("{name}")
87+
# "D406", # Section name should end with a newline ("{name}")
88+
# "D407", # Missing dashed underline after section ("{name}")
89+
"D408", # Section underline should be in the line following the section's name ("{name}")
90+
"D409", # Section underline should match the length of its name ("{name}")
91+
"D410", # Missing blank line after section ("{name}")
92+
"D411", # Missing blank line before section ("{name}")
93+
# "D412", # No blank lines allowed between a section header and its content ("{name}")
94+
"D413", # Missing blank line after last section ("{name}")
95+
"D414", # Section has no content ("{name}")
96+
# "D415", # First line should end with a period, question mark, or exclamation point
97+
"D416", # Section name should end with a colon ("{name}")
98+
"D417", # Missing argument description in the docstring for `{definition}`: `{name}`
99+
"D418", # Function decorated with `@overload` shouldn't contain a docstring
100+
"D419", # Docstring is empty
56101
# flake8-django ('DJ')
57102
# Django is not used in Sphinx
58103
# flake8-datetimez ('DTZ')

0 commit comments

Comments
 (0)