docs: Fix misleading comment in relevance function

Padmashree06 · web-flow · commit de9483f2027f · 2026-01-07T18:10:24.000+05:30
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 #1325
diff --git a/jsonschema/exceptions.py b/jsonschema/exceptions.py
@@ -415,7 +415,7 @@ def by_relevance(weak=WEAK_MATCHES, strong=STRONG_MATCHES):
     def relevance(error):
         validator = error.validator
         return (                        # prefer errors which are ...
-            -len(error.path),           # 'deeper' and thereby more specific
+            -len(error.path),           # 'higher up' (shorter path) and thereby more general
             error.path,                 # earlier (for sibling errors)
             validator not in weak,      # for a non-low-priority keyword
             validator in strong,        # for a high priority keyword
