Add missing backticks and brackets in docstrings

Author: erik-3milabs

src/int/div.rs

@@ -30,8 +30,8 @@ impl<const LIMBS: usize> Int<LIMBS> {
 
     /// Compute the quotient and remainder of `self / rhs`.
     ///
-    /// Returns `none` for the quotient when `Int::MIN / Int::MINUS_ONE`; that quotient cannot
-    /// be captured in an `Int`.
+    /// Returns `none` for the quotient when [`Int::MIN`] / [`Int::MINUS_ONE`]; that quotient cannot
+    /// be captured in an [`Int`].
     ///
     /// Example:
     /// ```
@@ -85,7 +85,7 @@ impl<const LIMBS: usize> Int<LIMBS> {
 /// Vartime checked division operations.
 impl<const LIMBS: usize> Int<LIMBS> {
     #[inline]
-    /// Variable time equivalent of [Self::div_rem_base]
+    /// Variable time equivalent of [`Self::div_rem_base`]
     ///
     /// This is variable only with respect to `rhs`.
     ///
@@ -106,7 +106,7 @@ impl<const LIMBS: usize> Int<LIMBS> {
         (quotient, remainder, lhs_sgn, rhs_sgn)
     }
 
-    /// Variable time equivalent of [Self::checked_div_rem]
+    /// Variable time equivalent of [`Self::checked_div_rem`]
     ///
     /// This is variable only with respect to `rhs`.
     ///
@@ -124,7 +124,7 @@ impl<const LIMBS: usize> Int<LIMBS> {
         )
     }
 
-    /// Variable time equivalent of [Self::checked_div]
+    /// Variable time equivalent of [`Self::checked_div`]
     ///
     /// This is variable only with respect to `rhs`.
     ///
@@ -137,7 +137,7 @@ impl<const LIMBS: usize> Int<LIMBS> {
         NonZero::new(*rhs).and_then(|rhs| self.checked_div_rem_vartime(&rhs).0.into())
     }
 
-    /// Variable time equivalent of [Self::rem]
+    /// Variable time equivalent of [`Self::rem`]
     ///
     /// This is variable only with respect to `rhs`.
     ///
@@ -153,7 +153,7 @@ impl<const LIMBS: usize> Int<LIMBS> {
 
 /// Vartime checked div-floor operations.
 impl<const LIMBS: usize> Int<LIMBS> {
-    /// Variable time equivalent of [Self::checked_div_rem_floor]
+    /// Variable time equivalent of [`Self::checked_div_rem_floor`]
     ///
     /// This is variable only with respect to `rhs`.
     ///
@@ -187,7 +187,7 @@ impl<const LIMBS: usize> Int<LIMBS> {
         (quotient, remainder)
     }
 
-    /// Variable time equivalent of [Self::checked_div_floor]
+    /// Variable time equivalent of [`Self::checked_div_floor`]
     ///
     /// This is variable only with respect to `rhs`.
     ///

src/int/div_uint.rs

@@ -62,7 +62,7 @@ impl<const LIMBS: usize> Int<LIMBS> {
 /// Vartime checked division operations.
 impl<const LIMBS: usize> Int<LIMBS> {
     #[inline]
-    /// Variable time equivalent of [Self::div_rem_base_uint`].
+    /// Variable time equivalent of [`Self::div_rem_base_uint`].
     ///
     /// This is variable only with respect to `rhs`.
     ///
@@ -77,7 +77,7 @@ impl<const LIMBS: usize> Int<LIMBS> {
         (quotient, remainder, lhs_sgn)
     }
 
-    /// Variable time equivalent of [Self::div_rem_uint`].
+    /// Variable time equivalent of [`Self::div_rem_uint`].
     ///
     /// This is variable only with respect to `rhs`.
     ///
@@ -94,7 +94,7 @@ impl<const LIMBS: usize> Int<LIMBS> {
         )
     }
 
-    /// Variable time equivalent of [Self::div_uint`].
+    /// Variable time equivalent of [`Self::div_uint`].
     ///
     /// This is variable only with respect to `rhs`.
     ///
@@ -107,7 +107,7 @@ impl<const LIMBS: usize> Int<LIMBS> {
         self.div_rem_uint_vartime(rhs).0
     }
 
-    /// Variable time equivalent of [Self::rem_uint`].
+    /// Variable time equivalent of [`Self::rem_uint`].
     ///
     /// This is variable only with respect to `rhs`.
     ///
@@ -205,7 +205,7 @@ impl<const LIMBS: usize> Int<LIMBS> {
 
 /// Vartime checked div-floor operations
 impl<const LIMBS: usize> Int<LIMBS> {
-    /// Variable time equivalent of [Self::div_rem_floor_uint`].
+    /// Variable time equivalent of [`Self::div_rem_floor_uint`].
     ///
     /// This is variable only with respect to `rhs`.
     ///
@@ -230,7 +230,7 @@ impl<const LIMBS: usize> Int<LIMBS> {
         (quotient, remainder)
     }
 
-    /// Variable time equivalent of [Self::div_floor_uint`].
+    /// Variable time equivalent of [`Self::div_floor_uint`].
     ///
     /// This is variable only with respect to `rhs`.
     ///
@@ -244,7 +244,7 @@ impl<const LIMBS: usize> Int<LIMBS> {
         q
     }
 
-    /// Variable time equivalent of [Self::normalized_rem`].
+    /// Variable time equivalent of [`Self::normalized_rem`].
     ///
     /// This is variable only with respect to `rhs`.
     ///

src/int/gcd.rs

@@ -177,7 +177,7 @@ impl<const LIMBS: usize> Odd<Int<LIMBS>> {
     }
 }
 
-/// Output of the Binary XGCD algorithm applied to two [Int]s.
+/// Output of the Binary XGCD algorithm applied to two [`Int`]s.
 pub type IntXgcdOutput<const LIMBS: usize> = XgcdOutput<LIMBS, Uint<LIMBS>>;
 
 /// Output of the Binary XGCD algorithm applied to two [`NonZero<Int<LIMBS>>`]s.

src/int/mul_uint.rs

@@ -81,8 +81,8 @@ impl<const LIMBS: usize> Int<LIMBS> {
         *product_abs.wrapping_neg_if(lhs_sign).as_int()
     }
 
-    /// Checked multiplication of self with an `Uint<RHS_LIMBS>`, where the result is to be stored
-    /// in an `Int<RHS_LIMBS>`.
+    /// Checked multiplication of self with an [`Uint<RHS_LIMBS>`], where the result is to be stored
+    /// in an [`Int<RHS_LIMBS>`].
     #[deprecated(since = "0.7.0", note = "please use `Uint::checked_mul(_int)` instead")]
     pub fn checked_mul_uint_right<const RHS_LIMBS: usize>(
         &self,

src/int/resize.rs

@@ -1,7 +1,7 @@
 use crate::{Int, Limb, Uint};
 
 impl<const LIMBS: usize> Int<LIMBS> {
-    /// Resize the representation of `self` to an `Int<T>`.
+    /// Resize the representation of `self` to an [`Int<T>`].
     /// Warning: this operation may lead to loss of information.
     #[inline(always)]
     pub const fn resize<const T: usize>(&self) -> Int<T> {

src/int/sub.rs

@@ -8,7 +8,7 @@ use subtle::CtOption;
 use crate::{Checked, CheckedSub, ConstChoice, ConstCtOption, Int, Wrapping};
 
 impl<const LIMBS: usize> Int<LIMBS> {
-    /// Perform subtraction, returning the result along with a [ConstChoice] which `is_true`
+    /// Perform subtraction, returning the result along with a [`ConstChoice`] which `is_true`
     /// only if the operation underflowed.
     pub const fn underflowing_sub(&self, rhs: &Self) -> (Self, ConstChoice) {
         // Step 1. subtract operands

src/modular/bingcd/extension.rs

@@ -6,7 +6,7 @@ pub(crate) struct ExtendedUint<const LIMBS: usize, const EXTENSION_LIMBS: usize>
 );
 
 impl<const LIMBS: usize, const EXTRA: usize> ExtendedUint<LIMBS, EXTRA> {
-    /// Construct an [ExtendedUint] from the product of a [Uint<LIMBS>] and an [Uint<EXTRA>].
+    /// Construct an [`ExtendedUint`] from the product of a [`Uint<LIMBS>`] and an [`Uint<EXTRA>`].
     ///
     /// Assumes the top bit of the product is not set.
     #[inline]
@@ -15,7 +15,7 @@ impl<const LIMBS: usize, const EXTRA: usize> ExtendedUint<LIMBS, EXTRA> {
         ExtendedUint(lo, hi)
     }
 
-    /// Interpret `self` as an [ExtendedInt]
+    /// Interpret `self` as an [`ExtendedInt`]
     #[inline]
     pub const fn as_extended_int(&self) -> ExtendedInt<LIMBS, EXTRA> {
         ExtendedInt(self.0, self.1)
@@ -106,15 +106,15 @@ pub(crate) struct ExtendedInt<const LIMBS: usize, const EXTENSION_LIMBS: usize>(
 );
 
 impl<const LIMBS: usize, const EXTRA: usize> ExtendedInt<LIMBS, EXTRA> {
-    /// Construct an [ExtendedInt] from the product of a [Uint<LIMBS>] and an [Int<EXTRA>].
+    /// Construct an [`ExtendedInt`] from the product of a [`Uint<LIMBS>`] and a [`Uint<EXTRA>`].
     ///
     /// Assumes the top bit of the product is not set.
     #[inline]
     pub const fn from_product(lhs: Uint<LIMBS>, rhs: Uint<EXTRA>) -> Self {
         ExtendedUint::from_product(lhs, rhs).as_extended_int()
     }
 
-    /// Interpret this as an [ExtendedUint].
+    /// Interpret this as an [`ExtendedUint`].
     #[inline]
     pub const fn as_extended_uint(&self) -> ExtendedUint<LIMBS, EXTRA> {
         ExtendedUint(self.0, self.1)

src/modular/bingcd/gcd.rs

@@ -92,8 +92,8 @@ impl<const LIMBS: usize> Odd<Uint<LIMBS>> {
     /// - `K`: the number of bits used when summarizing `self` and `rhs` for the inner loop. The
     ///   `K+1` top bits and `K-1` least significant bits are selected. It is recommended to keep
     ///   `K` close to a (multiple of) the number of bits that fit in a single register.
-    /// - `LIMBS_K`: should be chosen as the minimum number s.t. `Uint::<LIMBS>::BITS ≥ K`,
-    /// - `LIMBS_2K`: should be chosen as the minimum number s.t. `Uint::<LIMBS>::BITS ≥ 2K`.
+    /// - `LIMBS_K`: should be chosen as the minimum number s.t. [`Uint::<LIMBS>::BITS`] `≥ K`,
+    /// - `LIMBS_2K`: should be chosen as the minimum number s.t. [`Uint::<LIMBS>::BITS`] `≥ 2K`.
     #[inline]
     pub const fn optimized_bingcd_<const K: u32, const LIMBS_K: usize, const LIMBS_2K: usize>(
         &self,

src/uint.rs

@@ -222,7 +222,7 @@ impl<const LIMBS: usize> Uint<LIMBS> {
         }
     }
 
-    /// Convert this type into an [`Int`]; returns `None` if this value is greater than `Int::MAX`.
+    /// Convert this type into an [`Int`]; returns `None` if this value is greater than [`Int::MAX`].
     ///
     /// Note: this is the conversion operation. See [`Self::as_int`] for the unchecked equivalent.
     pub const fn try_into_int(self) -> ConstCtOption<Int<LIMBS>> {

src/uint/ref_type.rs

@@ -11,7 +11,7 @@ use crate::Word;
 
 /// Unsigned integer reference type.
 ///
-/// This type contains a limb slice which can be borrowed from either a `Uint` or `BoxedUint` and
+/// This type contains a limb slice which can be borrowed from either a [`Uint`] or [`BoxedUint`] and
 /// thus provides an abstraction for writing shared implementations.
 #[repr(transparent)]
 pub(crate) struct UintRef(pub [Limb]);