docs: enforce public docstring coverage via ruff D1 and backfill#20
Merged
Conversation
Add pydocstyle D1 rules to the ruff gate (D105/D107 ignored, tests exempt) so every public module, class, and function must carry a docstring stating its contract. Backfill the five missing docstrings (SOArmConfig.low/.high, SOArmDriver protocol methods), add a docs coverage badge, and document the gate in README and CLAUDE.md. interrogate -s -i -n -p src: 80.0% before, 92.5% after (the remaining misses are dunders the gate deliberately ignores: two __post_init__ and SOArmEmbodiment.__exit__). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds Ruff's pydocstyle presence rules (
D1) to the lint gate (D105/D107 exempt, tests excluded) and backfills the five missing public docstrings inconfig.pyandembodiment.py(the SOArmDriver protocol stubs and the config bound properties). Ruff D1 is fully clean; interrogate shows 92.5% because it counts three deliberately exempted dunders.Documented in CLAUDE.md and README, with the gate-backed docs-coverage badge.
All gates green locally: ruff check, ruff format, strict mypy, pytest at 100% branch coverage (82 passed).
Part of the org-wide rollout. Implemented by Codex (GPT), reviewed by Fable.
🤖 Generated with Claude Code