docs: Fix misleading comment in relevance function#1444
Merged
Julian merged 3 commits intopython-jsonschema:mainfrom Jan 8, 2026
Merged
docs: Fix misleading comment in relevance function#1444Julian merged 3 commits intopython-jsonschema:mainfrom
Julian merged 3 commits intopython-jsonschema:mainfrom
Conversation
The comment in the relevance() function incorrectly suggested that -len(error.path) prefers 'deeper' errors. In reality, this logic prioritizes errors with shorter paths (higher up in the instance). Updated the comment to accurately reflect that shorter paths are preferred for general validation errors, which aligns with the actual code behavior and official documentation for best_match. Closes python-jsonschema#1325
docs: Fix misleading comment in relevance function
Documentation build overview
Show files changed (1 files in total): 📝 1 modified | ➕ 0 added | ➖ 0 deleted
|
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.
The comment in the relevance() function incorrectly suggested that -len(error.path) prefers 'deeper' errors.
In reality, this logic prioritizes errors with shorter paths (higher up in the instance).
Updated the comment to accurately reflect that shorter paths are preferred for general validation errors, which aligns with the actual code behavior.
Closes #1325