Skip to content

Replace docformatter with pydocstringformatter#2867

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

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

Switches the docstring formatter and aligns config across tooling with broad, non-functional reformatting.

  • Replace docformatter with pydocstringformatter in .pre-commit-config.yaml and pyproject.toml; add [tool.pydocstringformatter] config
  • Update Ruff ignores (drop D200, allow via comments; keep D205, D212, D415, etc.) and add per-file ignores for generated/docs files
  • Remove [tool.docformatter] config
  • Mass docstring reflow to one-line summaries and wrapped lines; isolate some URLs onto their own lines to avoid breaking
  • No functional code changes (tests and implementation only touched for docstrings/formatting)

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

@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from 90c5f98 to ef09525 Compare January 26, 2026 11:37
@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from 461e305 to 52ee47c Compare January 26, 2026 11:41
@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from 3965cf2 to d4474ee Compare January 26, 2026 11:47
@adamtheturtle adamtheturtle force-pushed the replace-docformatter-with-pydocstringformatter branch from d4474ee to 571425a Compare January 26, 2026 11:52
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 571425a to 063a807 Compare January 26, 2026 11:57
@adamtheturtle adamtheturtle merged commit bb668bf into main Jan 26, 2026
104 checks passed
@adamtheturtle adamtheturtle deleted the replace-docformatter-with-pydocstringformatter branch January 26, 2026 12:12
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