Docs: separate consistency checks out of methods summaries#99
Merged
pressler-vsc merged 3 commits intomainfrom Jan 20, 2026
Merged
Docs: separate consistency checks out of methods summaries#99pressler-vsc merged 3 commits intomainfrom
pressler-vsc merged 3 commits intomainfrom
Conversation
pressler-vsc
requested review from
bombaci-vsc,
dhaverporth,
johnstob,
mstewart-vsc and
mtrachy
johnstob
approved these changes
Jan 8, 2026
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
2 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.
Description
In conjunction with @mtrachy
This PR proposes improving the
ConsistencyCheckerAPI documentation by:check_methods from the others to make it easier to discover all of the checkscheck_methods (they are described only by one-line summaries and don't need a whole page)Here is a screenshot of the proposed (left) and current (right):