Skip to content

Commit c4b28df

Browse files
committed
Use ruff to check for numpy-style docstrings
1 parent c3b03c6 commit c4b28df

File tree

1 file changed

+7
-22
lines changed

1 file changed

+7
-22
lines changed

pyproject.toml

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -44,30 +44,15 @@ ignore = [
4444
"RUF001", # String contains ambiguous character (such as Greek letters)
4545
"RUF002", # Docstring contains ambiguous character (such as Greek letters)
4646
"RUF012", # Mutable class attributes should be annotated with `typing.ClassVar`
47-
"D100",
48-
"D101",
49-
"D102",
50-
"D103",
51-
"D104",
52-
"D105",
53-
"D107",
54-
"D200",
55-
"D202",
56-
"D203",
57-
"D204",
58-
"D205",
59-
"D209",
60-
"D212",
61-
"D213",
62-
"D301",
63-
"D400",
64-
"D401",
65-
"D403",
66-
"D413",
67-
"D415",
68-
"D417",
47+
"D100", # Missing docstring in public module
48+
"D101", # Missing docstring in public class
49+
"D102", # Missing docstring in public method
50+
"D103", # Missing docstring in public function
6951
]
7052

53+
[tool.ruff.lint.pydocstyle]
54+
convention = "numpy"
55+
7156
[tool.ruff.lint.isort]
7257
lines-between-types = 1
7358

0 commit comments

Comments
 (0)