docs: resolve contributing.md docstring/CI-enforcement wording#104
Merged
Conversation
contributing.md contradicted conventions.md on whether public-method docstrings are unconditionally required, and understated what CI machine-checks vs. overview.md's finer breakdown. Per maintainer ruling: docstring requirement is unconditional, and both sections now link to their truth-home files instead of restating them.
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.
Summary
Follow-up to #103 — resolves the two policy-wording findings (I2, I3) from
planning/audits/2026-07-13-docs-comments-audit.mdthat needed a maintainer call rather than a code-vs-doc mismatch fix, tracked inplanning/changes/2026-07-13.08-contributing-docstring-ci-wording.md:docs/dev/contributing.mdsaid per-method docstrings are required "only when types alone are insufficient";architecture/conventions.mdsays public-method docstrings are unconditionally required. Ruling: unconditional wins (conventions.mdis the capability truth home) —contributing.mdnow links to it instead of restating.contributing.mdimplied onlyprint()is CI-machine-checked;architecture/overview.mddocuments a finer 3-tier breakdown (machine-checked / partially-checked / review-only). Ruling: link instead of restate, per the repo's own truth-home principle.Test plan
uvx --with-requirements docs/requirements.txt mkdocs build --strict— clean (verified the GitHub-absolute-link pattern matches every otherdocs/*.md→architecture/*.mdreference)just lint-ci— clean