Skip to content

Comments

Replace docformatter with pydocstringformatter#1161

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

Replace docformatter with pydocstringformatter#1161
adamtheturtle merged 1 commit 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

Replaces docstring formatter and aligns configs/tooling.

  • Swap docformatter for pydocstringformatter in dev deps and pre-commit; add [tool.pydocstringformatter] config
  • Update Ruff docstring rules (ignore D205, D212; per-file ignores for doccmd_*.py), keep formatter-conflict ignores
  • Apply docstring reformatting across code, docs, and tests to single-line summaries
  • No functional code changes; CI/pre-commit configuration updated accordingly

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

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 e3d0631 to fc936bd Compare January 26, 2026 11:37
@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from dcc9773 to 8a6603b Compare January 26, 2026 11:42
- 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 8a6603b to b903185 Compare January 26, 2026 11:52
@adamtheturtle adamtheturtle merged commit bb19a9b into main Jan 26, 2026
9 checks passed
@adamtheturtle adamtheturtle deleted the replace-docformatter-with-pydocstringformatter branch January 26, 2026 12:07
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