docs+style: 100% docstrings, interrogate config, ruff format + pin - #13
Merged
Conversation
Add concise, behavior-describing docstrings across the konjoai package to satisfy the documented gate (.claude/rules/python-conventions.md: "interrogate --fail-under 100 on all public APIs"), which was sitting at ~65%. Docstrings only — no code, logic, or signature changes; the few deletions are trivial `pass`/`...` stub bodies replaced by the docstring. Also add the missing [tool.interrogate] config to pyproject.toml encoding the "public APIs" policy (ignore private/dunder/__init__/nested/property, exclude tests/evals/demo) so the gate is reproducible. interrogate now passes at 100% both under that policy and with no ignores at all. Verified: interrogate 100%, 1287 passed / 7 skipped, ruff clean, DRY 0, vulture clean, complexity unchanged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016qhBs76YizHXGRK2yRu6VA
Header said v1.2.0 / 798 tests; package is v1.9.1 with 1287 tests passing. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016qhBs76YizHXGRK2yRu6VA
Run `ruff format .` repo-wide so `ruff format --check` (Wall 1 / CI) is clean. The drift came from CI installing a newer ruff (0.15.x) than the tree was last formatted with; pin ruff==0.15.18 in requirements-dev.txt so local and CI formatting stay in lockstep and this doesn't recur. Formatting only — no logic changes. 1287 passed / 7 skipped, ruff clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016qhBs76YizHXGRK2yRu6VA
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
3 participants
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.
Summary
Follow-up to #12, clearing the two remaining (CI non-blocking) Konjo findings plus a docs-accuracy fix. Three independent, reviewable commits:
1. Docstrings → 100% on public APIs (
82f2611)interrogatewas at ~65%. Added concise, behavior-describing docstrings across thekonjoaipackage and added the missing[tool.interrogate]config topyproject.tomlencoding the documented "interrogate --fail-under 100 on all public APIs" policy (ignore private/dunder/__init__/nested/property; exclude tests/evals/demo).pass/...stub bodies replaced by the docstring.2. Fix stale
CLAUDE.mdfacts (73c3988)Header said
v1.2.0/ 798 tests; the package isv1.9.1/ 1287 tests.3. Repo-wide
ruff format+ pin ruff (6e50db1)ruff format --check(Wall 1 / CI) was flagging 131 files — drift from CI installing a newer ruff than the tree was last formatted with. Ranruff format .(132 files, formatting only) and pinnedruff==0.15.18inrequirements-dev.txtso local and CI stay in lockstep and the drift doesn't recur.Verification (local)
pytest— 1287 passed, 7 skippedinterrogate— 100% ·ruff check+ruff format --check— clean🤖 Generated with Claude Code
Generated by Claude Code