Skip to content

Replace docformatter with pydocstringformatter#116

Merged
adamtheturtle merged 1 commit intomainfrom
replace-docformatter-with-pydocstringformatter
Jan 26, 2026
Merged

Replace docformatter with pydocstringformatter#116
adamtheturtle merged 1 commit intomainfrom
replace-docformatter-with-pydocstringformatter

Conversation

@adamtheturtle
Copy link
Owner

@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 and .pre-commit-config.yaml
  • Add [tool.pydocstringformatter] config; remove [tool.docformatter]
  • Update Ruff ignores to align with new docstring style (ignore D205, D212), add per-file ignores for doccmd_*.py

Formatting

  • Reformat docstrings throughout src, tests, and docs (single-line summaries, wrapping)

No functional code changes; behavior unaffected.

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

@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from 74dc574 to 10662e3 Compare January 26, 2026 11:37
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from 10662e3 to 2c9dcd3 Compare January 26, 2026 11:42
@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from 2c9dcd3 to faea7d3 Compare January 26, 2026 11:44
@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from faea7d3 to ac0a8fd Compare January 26, 2026 11:52
- 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 ac0a8fd to fdb967d Compare January 26, 2026 11:57
@adamtheturtle adamtheturtle merged commit 114db5a into main Jan 26, 2026
16 checks passed
@adamtheturtle adamtheturtle deleted the replace-docformatter-with-pydocstringformatter branch January 26, 2026 12:08
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