docs(validation): state invariants in comments, not prior behaviour - #134
Merged
Conversation
- select_rules, _ADVICE_LEVELS, severity and _read_rules_schema described the defect each addressed rather than what it guarantees
Contributor
Release previewNo version bump from the current commits (stays at Changelog preview (truncated)Preview via python-semantic-release and conventional commits. |
Contributor
📊 Benchmark ResultsClick to see benchmark comparisonThreshold: 1.3x (30% slower triggers a regression warning) Note: Benchmarks are informational only and won't fail the build. 💡 Tip: Download the |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Four comments explained the defect the code was added for rather than what it now guarantees. Once that code is gone the reference is unreadable, and the history belongs in the commit that made the change.
Changes
select_rules- states that the CLI and the MCP server share it so both answer a query identically, and thatunenforced_onlyselects the population beforeareanarrows it. Drops the account of how the two copies diverged._ADVICE_LEVELS- states that it is enumerated so an unrecognised level is a distinct case rather than one this set absorbs.severity- states that the vocabulary grows and the raise is reachable whenever a version is vendored, without naming the keyword that prompted it._read_rules_schema- states that absent and corrupt must stay distinguishable, and what collapsing them would allow.No behaviour change. 463 validation tests pass,
make checkexits 0.