docs: enforce public docstring coverage via ruff D1 and backfill#26
Merged
Conversation
Enable Ruff D1 for public API symbols and backfill CLI contracts so missing public docstrings fail the quality gate. Exempt tests and build scripts from the public API check, document contributor expectations, and advertise the 100% gate in the README badge block. Interrogate coverage: 80.0% before, 100.0% after. 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 and the mkdocs-gen-files build script under scripts/ excluded) and backfills the two missing public docstrings incli.py. Public docstring coverage (interrogate, excluding private/nested/init): 80.0% -> 100.0%.Documented in CLAUDE.md, README, and docs/contributing.md (so external benchmark PRs see the requirement), with the gate-backed docs-coverage badge in the README.
All gates green locally: ruff check, ruff format, strict mypy, pytest at 100% coverage, mkdocs build --strict.
Part of the org-wide rollout. Implemented by Codex (GPT), reviewed by Fable.
🤖 Generated with Claude Code