Skip to content

Commit e3d0631

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 6e537af commit e3d0631

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
@@ -43,12 +43,12 @@ optional-dependencies.dev = [
4343
"deptry==0.24.0",
4444
"doc8==2.0.0",
4545
"doccmd==2026.1.23.4",
46-
"docformatter==1.7.7",
4746
"furo==2025.12.19",
4847
"interrogate==1.7.0",
4948
"mypy[faster-cache]==1.19.1",
5049
"mypy-strict-kwargs==2026.1.12",
5150
"prek==0.3.0",
51+
"pydocstringformatter==0.7.3",
5252
"pylint[spelling]==4.0.4",
5353
"pyproject-fmt==2.11.1",
5454
"pyrefly==0.49.0",
@@ -116,8 +116,8 @@ lint.select = [
116116
lint.ignore = [
117117
# Ruff warns that this conflicts with the formatter.
118118
"COM812",
119-
# Allow our chosen docstring line-style - no one-line summary.
120-
"D200",
119+
# Allow our chosen docstring line-style - pydocstringformatter handles formatting
120+
# but doesn't enforce D205 (blank line after summary) or D212 (summary on first line).
121121
"D205",
122122
"D212",
123123
"D415",
@@ -245,9 +245,6 @@ spelling-private-dict-file = 'spelling_private_dict.txt'
245245
# --spelling-private-dict-file option instead of raising a message.
246246
spelling-store-unknown-words = 'no'
247247

248-
[tool.docformatter]
249-
make-summary-multi-line = true
250-
251248
[tool.check-manifest]
252249

253250
ignore = [
@@ -318,6 +315,12 @@ enableTypeIgnoreComments = false
318315
reportUnnecessaryTypeIgnoreComment = true
319316
typeCheckingMode = "strict"
320317

318+
[tool.pydocstringformatter]
319+
write = true
320+
split-summary-body = false
321+
max-line-length = 75
322+
linewrap-full-docstring = true
323+
321324
[tool.interrogate]
322325
fail-under = 100
323326
omit-covered-files = true

0 commit comments

Comments
 (0)