Skip to content

Replace docformatter with pydocstringformatter#1523

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

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

Conversation

@adamtheturtle
Copy link
Copy Markdown
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 migration and docstring formatting

  • Replace docformatter with pydocstringformatter in pyproject.toml and add [tool.pydocstringformatter] config
  • Update .pre-commit-config.yaml: remove docformatter hook, add pydocstringformatter hook; adjust CI skip list
  • Adjust Ruff config: ignore D205/D212, move D200 to per-file ignores for docs; keep existing lint settings
  • Reformat docstrings project-wide (modules, tests, fixtures, Sphinx config) to match new formatter; no functional code changes

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

Copy link
Copy Markdown

@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.

Comment thread pyproject.toml
@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from e8fde5c to 294d8ee Compare January 26, 2026 11:37
@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from 88c42ce to b9144f6 Compare January 26, 2026 11:42
@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from b9144f6 to 18f73b2 Compare January 26, 2026 11:47
- 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 18f73b2 to f314727 Compare January 26, 2026 11:52
@adamtheturtle adamtheturtle merged commit 71b1f24 into main Jan 26, 2026
10 checks passed
@adamtheturtle adamtheturtle deleted the replace-docformatter-with-pydocstringformatter branch January 26, 2026 12:03
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