Skip to content

Commit 87794eb

Browse files
committed
Replace docformatter with pydocstringformatter
- Replace docformatter==1.7.7 with pydocstringformatter==0.7.3 - Replace [tool.docformatter] with [tool.pydocstringformatter] config - Update ruff ignore comments (D200 -> D205/D212) - Don't use linewrap-full-docstring to avoid breaking URLs (DanielNoord/pydocstringformatter#540)
1 parent 0f39eec commit 87794eb

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

pyproject.toml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,14 @@ optional-dependencies.dev = [
4242
"deptry==0.24.0",
4343
"doc8==2.0.0",
4444
"doccmd==2026.1.23.4",
45-
"docformatter==1.7.7",
4645
"freezegun==1.5.5",
4746
"furo==2025.12.19",
4847
"hadolint-bin==2.14.0; sys_platform!='win32'",
4948
"interrogate==1.7.0",
5049
"mypy[faster-cache]==1.19.1",
5150
"mypy-strict-kwargs==2026.1.12",
5251
"prek==0.3.0",
52+
"pydocstringformatter==0.7.3",
5353
"pylint[spelling]==4.0.4",
5454
"pyproject-fmt==2.11.1",
5555
"pyrefly==0.49.0",
@@ -118,8 +118,8 @@ lint.select = [
118118
lint.ignore = [
119119
# Ruff warns that this conflicts with the formatter.
120120
"COM812",
121-
# Allow our chosen docstring line-style - no one-line summary.
122-
"D200",
121+
# Allow our chosen docstring line-style - pydocstringformatter handles formatting
122+
# but doesn't enforce D205 (blank line after summary) or D212 (summary on first line).
123123
"D205",
124124
"D212",
125125
# Allow backslashes in a docstring.
@@ -260,9 +260,6 @@ spelling-private-dict-file = 'spelling_private_dict.txt'
260260
# --spelling-private-dict-file option instead of raising a message.
261261
spelling-store-unknown-words = 'no'
262262

263-
[tool.docformatter]
264-
make-summary-multi-line = true
265-
266263
[tool.check-manifest]
267264

268265
ignore = [
@@ -340,6 +337,12 @@ enableTypeIgnoreComments = false
340337
reportUnnecessaryTypeIgnoreComment = true
341338
typeCheckingMode = "strict"
342339

340+
[tool.pydocstringformatter]
341+
write = true
342+
split-summary-body = false
343+
max-line-length = 75
344+
linewrap-full-docstring = true
345+
343346
[tool.interrogate]
344347
fail-under = 100
345348
omit-covered-files = true

0 commit comments

Comments
 (0)