Adjust docs for SearchResult to mention search_and_format

sirbrillig · Jul 25, 2024 · 7fa41d9 · 7fa41d9
1 parent ff8a168
commit 7fa41d9
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -318,9 +318,9 @@ pub enum SearchResultFormat {
     JsonPerMatch,
 }
 
-/// A result from calling [Searcher::search]
+/// A result from calling [Searcher::search] or [Searcher::search_and_format]
 ///
-/// The `line_number` will be set only if [Args::line_number] is true when calling [Searcher::search].
+/// Note that `line_number` will be set only if [Args::line_number] is true when searching.
 #[derive(Debug, PartialEq, Clone, Serialize)]
 pub struct SearchResult {
     /// The path to the file containing the symbol definition