add comment

chenyukang · chenyukang · commit 4fc3c6b07a5a · 2023-04-06T06:51:49.000+08:00
diff --git a/compiler/rustc_span/src/edit_distance.rs b/compiler/rustc_span/src/edit_distance.rs
@@ -218,6 +218,9 @@ fn find_best_match_for_name_impl(
         }
     }
 
+    // We have a tie among several candidates, try to select the best among them ignoring substrings.
+    // For example, the candidates list `force_capture`, `capture`, and user inputed `forced_capture`,
+    // we select `force_capture` with a extra round of edit distance calculation.
     if next_candidates.len() > 1 {
         debug_assert!(use_substring_score);
         best = find_best_match_for_name_impl(

Original file line number	Diff line number	Diff line change
`@@ -218,6 +218,9 @@ fn find_best_match_for_name_impl(`
`218`	`218`	`}`
`219`	`219`	`}`
`220`	`220`
	`221`	`+ // We have a tie among several candidates, try to select the best among them ignoring substrings.`
	`222`	+ // For example, the candidates list `force_capture`, `capture`, and user inputed `forced_capture`,
	`223`	+ // we select `force_capture` with a extra round of edit distance calculation.
`221`	`224`	`if next_candidates.len() > 1 {`
`222`	`225`	`debug_assert!(use_substring_score);`
`223`	`226`	`best = find_best_match_for_name_impl(`