Skip to content

Replace docformatter with pydocstringformatter#716

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

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

Conversation

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

  • Replace docformatter with pydocstringformatter in dev deps and pre-commit; add [tool.pydocstringformatter] config and remove [tool.docformatter]
  • Adjust Ruff rules (docstring checks) and per-file ignores to align with new formatter
  • Update pre-commit hook definitions and CI skip list accordingly
  • Reformat docstrings across src/ and tests/ to new style (one-line summaries, wrapping), with no functional code changes

Written by Cursor Bugbot for commit 8228776. 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 3 times, most recently from 8d32f29 to 29e824c 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 29e824c to 8228776 Compare January 26, 2026 11:52
@adamtheturtle adamtheturtle merged commit 1a40d26 into main Jan 26, 2026
14 of 30 checks passed
@adamtheturtle adamtheturtle deleted the replace-docformatter-with-pydocstringformatter branch January 26, 2026 12:11
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