Skip to content

Replace docformatter with pydocstringformatter#202

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

Replace docformatter with pydocstringformatter#202
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

Replaces the docstring formatting tool and updates related configs.

  • Swap pre-commit hook from docformatter to pydocstringformatter and update CI skip list
  • Remove docformatter from dev dependencies; add pydocstringformatter==0.7.3
  • Add [tool.pydocstringformatter] config (write=true, max-line-length=79, line wrapping, etc.) in pyproject.toml
  • No runtime/production code changes

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

@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from 57b0070 to 58dfcc5 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.

- 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 58dfcc5 to 4f0d61c Compare January 26, 2026 12:04
@adamtheturtle adamtheturtle merged commit ee1418d into main Jan 26, 2026
9 checks passed
@adamtheturtle adamtheturtle deleted the replace-docformatter-with-pydocstringformatter branch January 26, 2026 12:09
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