Replace docformatter with pydocstringformatter#1518
Conversation
3da3a3c to
4bff8da
Compare
53b327a to
5de2f56
Compare
9912e12 to
396c074
Compare
- 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)
396c074 to
fd7b96b
Compare
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
| lint.per-file-ignores."doccmd_*.py" = [ | ||
| # Allow our chosen docstring line-style - pydocstringformatter handles | ||
| # formatting but docstrings in docs may not match this style. | ||
| "D200", |
There was a problem hiding this comment.
D200 ignore pattern misses docs/source/doccmd files
Low Severity
The ruff per-file-ignores pattern doccmd_*.py only matches root-level files, not files in subdirectories like docs/source/doccmd_*.py. The pylint config (line 247) shows the project expects files matching docs/source/doccmd_*.py to exist. Before this PR, D200 was globally ignored so all doccmd files were covered. Now only root-level doccmd files have D200 ignored, creating a gap where docs/source/doccmd_*.py files could trigger D200 violations. The pattern could be changed to **/doccmd_*.py or a separate entry added for docs/source/doccmd_*.py.
Replace docformatter with pydocstringformatter.
This follows the same pattern as VWS-Python/vws-python#2793.
Changes:
docformatter==1.7.7withpydocstringformatter==0.7.3Note
Replaces the docstring formatter and aligns configs and ignores accordingly.
docformatterwithpydocstringformatterinpyproject.tomland add[tool.pydocstringformatter]config.pre-commit-config.yamlhook fromdocformattertopydocstringformatterD200globally; ignoreD205,D212; per-file ignore forD200indoccmd_*.py)src/,tests/, anddocs/to new style (one-line summaries, wrapped lines)tool.docformattersettingsWritten by Cursor Bugbot for commit fd7b96b. This will update automatically on new commits. Configure here.