docs: enforce public docstring coverage via ruff D1 and backfill#2
Merged
Conversation
Enable Ruff's public pydocstyle rules via extend-select (preserving the default rule baseline), exempt magic methods and __init__, exclude tests, and backfill the two missing public docstrings in cli.py. Document the gate in CLAUDE.md and README, with the gate-backed docs-coverage badge. Interrogate public docstring coverage: 81.8% before, 100.0% after. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
jeqcho
force-pushed
the
docs/public-docstring-gate
branch
from
July 14, 2026 01:15
11ff15b to
4171335
Compare
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 via
extend-select = ["D1"](this repo runs ruff's default rule set, soextend-selectpreserves the baseline) with D105/D107 exempt and tests excluded. Backfills the two missing public docstrings incli.py. Public docstring coverage (interrogate, excluding private/nested/init): 81.8% -> 100.0%.The requirement is documented in CLAUDE.md and the README, and the README gains the gate-backed docs-coverage badge next to the existing badges.
All gates green locally: ruff check, ruff format, strict mypy, pytest at 100% coverage (9 passed).
Part of the org-wide rollout (kitchenbench #22, inspect-robots #51, plus yam/so101/worldevals in flight). Implemented by Codex (GPT), reviewed by Fable.
🤖 Generated with Claude Code