Skip to content

Commit 5cced56

Browse files
Merge pull request #2027 from VWS-Python/ruff-google-convention
Enforce Google style docstrings with ruff
2 parents 32dfb3b + 783411c commit 5cced56

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

pyproject.toml

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -210,19 +210,9 @@ ignore = [
210210
"COM812",
211211
# Allow our chosen docstring line-style - no one-line summary.
212212
"D200",
213-
"D203",
214213
"D205",
215214
"D212",
216-
"D213",
217-
"D400",
218215
"D415",
219-
# It is too much work to make every docstring imperative.
220-
"D401",
221-
# We ignore some docstyle errors which do not apply to Google style
222-
# docstrings.
223-
"D406",
224-
"D407",
225-
"D413",
226216
# Ruff warns that this conflicts with the formatter.
227217
"ISC001",
228218
# We have an existing interface to support and so we do not want to change
@@ -246,6 +236,9 @@ ignore = [
246236
# is sometimes annoyingly removed.
247237
unfixable = ["ERA001"]
248238

239+
[tool.ruff.lint.pydocstyle]
240+
convention = "google"
241+
249242
[tool.ruff.lint.per-file-ignores]
250243
"tests/**" = [
251244
# Allow possible hardcoded passwords in tests.

0 commit comments

Comments
 (0)