docs(standard): amend the requirements the conformance audit found out of step - #114
Merged
Merged
Conversation
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
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
A conformance audit of the 23 core repos against the requirement IDs (#112) found five places where the standard, not the repos, is out of step: nearly every repo departs from the requirement, and for a reason the standard should accept. This PR amends those. The drift in individual repos is fixed by separate sweeps.
Changes
flask,celery,redis,kafka, ...). The vocabulary now fixes the spelling of shared concepts; other topics are the repo's call. Still at most 12 (lite-bootstrap has 13, a sweep fixes that).[Modern-DI](...) integration for [FastAPI](...)). The requirement now asks for a sentence that states the one-liner, and allows rewording and links.omit. faststream-outbox, httpware, modern-di and modern-di-grpc omit benchmarks or generated protos.omitmay now list directories that are not the package, the same carve-out TY2 grants ty. Excluding a file of the package stays forbidden (compose2pod's__main__.pyomit remains drift).pragma: no cover. TS5 said nothing about line pragmas; 16 repos use them. A pragma is allowed and must carry its reason on the same line. About 204 of 225 pragmas have none today, so per "Changing the standard" the reason requirement lands as SHOULD and becomes MUST on 2026-11-01.release.ymlalso moves the floating major tag (v0) because the repo is a GitHub Action consumers pin by major.Checklist
uv run pytest: 132 passed, 29 skipped)mkdocs build --strictpasses; every in-page anchor resolves, including the new#TS6uv build, metadata: not applicable, docs only