Improvements to doc linking, grammar, etc.

src/termdict/fst_termdict/merger.rs

@@ -36,10 +36,10 @@ impl<'a> TermMerger<'a> {
         }
     }
 
-    /// Iterator over (segment ordinal, [TermOrdinal]) sorted by segment ordinal
+    /// Iterator over `(segment ordinal, TermOrdinal)` pairs sorted by segment ordinal
     ///
     /// This method may be called
-    /// if [Self::advance] has been called before
+    /// if [`Self::advance`] has been called before
     /// and `true` was returned.
     pub fn matching_segments<'b: 'a>(&'b self) -> impl 'b + Iterator<Item = (usize, TermOrdinal)> {
         self.current_segment_and_term_ordinals
@@ -68,17 +68,15 @@ impl<'a> TermMerger<'a> {
 
     /// Returns the current term.
     ///
-    /// This method may be called
-    /// if [Self::advance] has been called before
+    /// This method may be called if [`Self::advance`] has been called before
     /// and `true` was returned.
     pub fn key(&self) -> &[u8] {
         &self.current_key
     }
 
-    /// Iterator over (segment ordinal, [TermInfo]) pairs iterator sorted by the ordinal.
+    /// Iterator over `(segment ordinal, TermInfo)` pairs sorted by the ordinal.
     ///
-    /// This method may be called
-    /// if [Self::advance] has been called before
+    /// This method may be called if [`Self::advance`] has been called before
     /// and `true` was returned.
     pub fn current_segment_ords_and_term_infos<'b: 'a>(
         &'b self,

src/termdict/fst_termdict/mod.rs

@@ -1,9 +1,9 @@
-//! The term dictionary main role is to associate the sorted [`Term`s](../struct.Term.html) to
-//! a [`TermInfo`](../postings/struct.TermInfo.html) struct that contains some meta-information
+//! The term dictionary main role is to associate the sorted [`Term`](crate::Term)s with
+//! a [`TermInfo`](crate::postings::TermInfo) struct that contains some meta-information
 //! about the term.
 //!
 //! Internally, the term dictionary relies on the `fst` crate to store
-//! a sorted mapping that associate each term to its rank in the lexicographical order.
+//! a sorted mapping that associates each term to its rank in the lexicographical order.
 //! For instance, in a dictionary containing the sorted terms "abba", "bjork", "blur" and "donovan",
 //! the `TermOrdinal` are respectively `0`, `1`, `2`, and `3`.
 //!
@@ -17,7 +17,7 @@
 //! as `u64`.
 //!
 //! A second datastructure makes it possible to access a
-//! [`TermInfo`](../postings/struct.TermInfo.html).
+//! [`TermInfo`](crate::postings::TermInfo).
 mod merger;
 mod streamer;
 mod term_info_store;

src/termdict/mod.rs

@@ -1,11 +1,11 @@
-//! The term dictionary main role is to associate the sorted [`Term`s](../struct.Term.html) to
-//! a [`TermInfo`](../postings/struct.TermInfo.html) struct that contains some meta-information
+//! The term dictionary main role is to associate the sorted [`Term`s](crate::Term) to
+//! a [`TermInfo`](crate::postings::TermInfo) struct that contains some meta-information
 //! about the term.
 //!
 //! Internally, the term dictionary relies on the `fst` crate to store
 //! a sorted mapping that associate each term to its rank in the lexicographical order.
 //! For instance, in a dictionary containing the sorted terms "abba", "bjork", "blur" and "donovan",
-//! the [TermOrdinal] are respectively `0`, `1`, `2`, and `3`.
+//! the [`TermOrdinal`] are respectively `0`, `1`, `2`, and `3`.
 //!
 //! For `u64`-terms, tantivy explicitly uses a `BigEndian` representation to ensure that the
 //! lexicographical order matches the natural order of integers.
@@ -17,7 +17,7 @@
 //! as `u64`.
 //!
 //! A second datastructure makes it possible to access a
-//! [`TermInfo`](../postings/struct.TermInfo.html).
+//! [`TermInfo`](crate::postings::TermInfo).
 
 #[cfg(not(feature = "quickwit"))]
 mod fst_termdict;