Skip to content

Ruff D issues - #193

Merged
pjljvandelaar merged 44 commits into
mainfrom
RUFF
Sep 18, 2026
Merged

pjljvandelaar merged 44 commits into
mainfrom
RUFF

Conversation

@pjljvandelaar

Copy link
Copy Markdown
Collaborator

As agreed in the CCB, addition of missing documentation using AI.

@pjljvandelaar

Copy link
Copy Markdown
Collaborator Author

Current Status

Remove Ruff D (pydocstyle) issues: D107 & D205

Summary

Adds docstrings/fixes formatting to eliminate two pydocstyle rule violations across the repo:

D107 (undocumented-public-init): added docstrings to 30 init methods that previously had none.
D205 (missing-blank-line-after-summary): added a blank line between the summary line and extended description in 16 files' multi-line docstrings.

Changes
docs(ruff): fix D107 across repo — 30 files, +50 lines.
docs(ruff): fix D205 across repo — 16 files, +37/-21 lines.
fix(ruff): resolve D400/D415/D202 regressions from D107/D205 slices — 9 files, +19/-33 lines. Follow-up cleanup: reformatting some D205 fixes to satisfy line-length (E501) briefly left 11 docstring summaries without terminal punctuation (D400/D415), and one init docstring added during the D107 pass left a stray blank line (D202). All are now resolved by rewording/restructuring the affected summaries.
Verification
uv run ruff check --select=D107,D205,D400,D415,D202 — 0 violations (4 remaining D400 hits are pre-existing, unrelated to this work).
uv run ruff check . — all checks pass.
uv run pytest -q — 2314 passed, 93 skipped, 34 xfailed (unchanged before/after; only docstring text was touched, no logic changes).

Notes for reviewers
No functional code changes — docstring/comment-only edits.
D415 was not part of the original planned rule list but is closely related to D400 and is now included going forward.
Remaining D rules are tracked for follow-up slices (D100/101/102/103/104/105/401/404/417, plus 4 pre-existing D400 cases).

Comment thread features/steps/test_steps.py
@pjljvandelaar
pjljvandelaar marked this pull request as draft September 18, 2026 07:38
@pjljvandelaar

Copy link
Copy Markdown
Collaborator Author

@FrancescoPezzella I started with a particular strategy, yet the AI occasionally deviated from that.
I am wondering what you like and didn't like of the different commits and how you review this pull request.
Taking yourself as a user of your (future) tool - it is nice to discover what info you like, what you miss, and what you don't like!

@pjljvandelaar

Copy link
Copy Markdown
Collaborator Author

Only D102 issue to be solved

@pjljvandelaar
pjljvandelaar marked this pull request as ready for review September 18, 2026 13:29
@pjljvandelaar
pjljvandelaar merged commit 3e9f41c into main Sep 18, 2026
8 checks passed
@pjljvandelaar
pjljvandelaar deleted the RUFF branch September 18, 2026 14:40
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.

2 participants