Skip to content

Replace docformatter with pydocstringformatter#1891

Merged
adamtheturtle merged 2 commits intomainfrom
replace-docformatter-with-pydocstringformatter
Jan 26, 2026
Merged

Replace docformatter with pydocstringformatter#1891
adamtheturtle merged 2 commits intomainfrom
replace-docformatter-with-pydocstringformatter

Conversation

@adamtheturtle
Copy link
Member

@adamtheturtle adamtheturtle commented Jan 26, 2026

Replace docformatter with pydocstringformatter.

This follows the same pattern as VWS-Python/vws-python#2793.

Changes:

  • Replace docformatter==1.7.7 with pydocstringformatter==0.7.3
  • Update tool configuration in pyproject.toml
  • Update ruff ignore rules (D200 → D205, D212)
  • Format docstrings with new tool
  • Workaround URL breaking issue by isolating URLs on their own lines where needed

Note

Tooling change

  • Replace docformatter with pydocstringformatter in dev deps, pre-commit hook, and uv.lock
  • Add [tool.pydocstringformatter] config and remove tool.docformatter settings
  • Update Ruff rules: keep D205, D212 ignored globally; move D200 ignore to doccmd_*.py; add per-file ignores for tests

Codebase-wide formatting

  • Reformat docstrings to one-line/wrapped style across src/, tests/, docs/, and entrypoint scripts; no functional logic changes

Risk: Low — config and formatting-only changes; runtime behavior unaffected

Written by Cursor Bugbot for commit 91e432b. This will update automatically on new commits. Configure here.

- 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)
@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from 21d9086 to e8d65cc Compare January 26, 2026 11:37
@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from f1f8f82 to 06d6bdb Compare January 26, 2026 11:41
@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from 2316e84 to 0fc0512 Compare January 26, 2026 11:47
@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from 0fc0512 to 91e432b Compare January 26, 2026 11:52
@adamtheturtle adamtheturtle merged commit 8a9664b into main Jan 26, 2026
10 checks passed
@adamtheturtle adamtheturtle deleted the replace-docformatter-with-pydocstringformatter branch January 26, 2026 12:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant