Rollup merge of rust-lang#133019 - sorairolake:add-missing-period-and-colon, r=tgross35

workingjubilee · web-flow · commit e1448dee6d0c · 2024-11-14T17:55:26.000-08:00
docs: Fix missing period and colon in methods for primitive types Closes rust-lang#133018
diff --git a/core/src/num/int_macros.rs b/core/src/num/int_macros.rs
@@ -1300,7 +1300,7 @@ macro_rules! int_impl {
             }
         }
 
-        /// Unbounded shift left. Computes `self << rhs`, without bounding the value of `rhs`
+        /// Unbounded shift left. Computes `self << rhs`, without bounding the value of `rhs`.
         ///
         /// If `rhs` is larger or equal to the number of bits in `self`,
         /// the entire value is shifted out, and `0` is returned.
@@ -1423,7 +1423,7 @@ macro_rules! int_impl {
             }
         }
 
-        /// Unbounded shift right. Computes `self >> rhs`, without bounding the value of `rhs`
+        /// Unbounded shift right. Computes `self >> rhs`, without bounding the value of `rhs`.
         ///
         /// If `rhs` is larger or equal to the number of bits in `self`,
         /// the entire value is shifted out, which yields `0` for a positive number,
@@ -2389,7 +2389,7 @@ macro_rules! int_impl {
             (res, overflowed ^ (rhs < 0))
         }
 
-        /// Calculates `self` - `rhs`
+        /// Calculates `self` - `rhs`.
         ///
         /// Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow
         /// would occur. If an overflow would have occurred then the wrapped value is returned.
@@ -2470,7 +2470,7 @@ macro_rules! int_impl {
             (c, b != d)
         }
 
-        /// Calculates `self` - `rhs` with an unsigned `rhs`
+        /// Calculates `self` - `rhs` with an unsigned `rhs`.
         ///
         /// Returns a tuple of the subtraction along with a boolean indicating
         /// whether an arithmetic overflow would occur. If an overflow would
diff --git a/core/src/num/uint_macros.rs b/core/src/num/uint_macros.rs
@@ -1517,7 +1517,7 @@ macro_rules! uint_impl {
             }
         }
 
-        /// Unbounded shift left. Computes `self << rhs`, without bounding the value of `rhs`
+        /// Unbounded shift left. Computes `self << rhs`, without bounding the value of `rhs`.
         ///
         /// If `rhs` is larger or equal to the number of bits in `self`,
         /// the entire value is shifted out, and `0` is returned.
@@ -1640,7 +1640,7 @@ macro_rules! uint_impl {
             }
         }
 
-        /// Unbounded shift right. Computes `self >> rhs`, without bounding the value of `rhs`
+        /// Unbounded shift right. Computes `self >> rhs`, without bounding the value of `rhs`.
         ///
         /// If `rhs` is larger or equal to the number of bits in `self`,
         /// the entire value is shifted out, and `0` is returned.
@@ -2299,7 +2299,7 @@ macro_rules! uint_impl {
         ///
         /// # Examples
         ///
-        /// Basic usage
+        /// Basic usage:
         ///
         /// ```
         #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".overflowing_add(2), (7, false));")]
@@ -2389,15 +2389,15 @@ macro_rules! uint_impl {
             (res, overflowed ^ (rhs < 0))
         }
 
-        /// Calculates `self` - `rhs`
+        /// Calculates `self` - `rhs`.
         ///
         /// Returns a tuple of the subtraction along with a boolean indicating
         /// whether an arithmetic overflow would occur. If an overflow would
         /// have occurred then the wrapped value is returned.
         ///
         /// # Examples
         ///
-        /// Basic usage
+        /// Basic usage:
         ///
         /// ```
         #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".overflowing_sub(2), (3, false));")]
@@ -2550,7 +2550,7 @@ macro_rules! uint_impl {
         ///
         /// # Examples
         ///
-        /// Basic usage
+        /// Basic usage:
         ///
         /// ```
         #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".overflowing_div(2), (2, false));")]
@@ -2581,7 +2581,7 @@ macro_rules! uint_impl {
         ///
         /// # Examples
         ///
-        /// Basic usage
+        /// Basic usage:
         ///
         /// ```
         #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".overflowing_div_euclid(2), (2, false));")]
@@ -2609,7 +2609,7 @@ macro_rules! uint_impl {
         ///
         /// # Examples
         ///
-        /// Basic usage
+        /// Basic usage:
         ///
         /// ```
         #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".overflowing_rem(2), (1, false));")]
@@ -2640,7 +2640,7 @@ macro_rules! uint_impl {
         ///
         /// # Examples
         ///
-        /// Basic usage
+        /// Basic usage:
         ///
         /// ```
         #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".overflowing_rem_euclid(2), (1, false));")]
@@ -2664,7 +2664,7 @@ macro_rules! uint_impl {
         ///
         /// # Examples
         ///
-        /// Basic usage
+        /// Basic usage:
         ///
         /// ```
         #[doc = concat!("assert_eq!(0", stringify!($SelfT), ".overflowing_neg(), (0, false));")]
@@ -2689,7 +2689,7 @@ macro_rules! uint_impl {
         ///
         /// # Examples
         ///
-        /// Basic usage
+        /// Basic usage:
         ///
         /// ```
         #[doc = concat!("assert_eq!(0x1", stringify!($SelfT), ".overflowing_shl(4), (0x10, false));")]
@@ -2715,7 +2715,7 @@ macro_rules! uint_impl {
         ///
         /// # Examples
         ///
-        /// Basic usage
+        /// Basic usage:
         ///
         /// ```
         #[doc = concat!("assert_eq!(0x10", stringify!($SelfT), ".overflowing_shr(4), (0x1, false));")]
diff --git a/core/src/str/mod.rs b/core/src/str/mod.rs
@@ -2400,7 +2400,7 @@ impl str {
     ///
     /// # Examples
     ///
-    /// Basic usage
+    /// Basic usage:
     ///
     /// ```
     /// let four: u32 = "4".parse().unwrap();

Original file line number	Diff line number	Diff line change
`@@ -1300,7 +1300,7 @@ macro_rules! int_impl {`
`1300`	`1300`	`}`
`1301`	`1301`	`}`
`1302`	`1302`
`1303`		- /// Unbounded shift left. Computes `self << rhs`, without bounding the value of `rhs`
	`1303`	+ /// Unbounded shift left. Computes `self << rhs`, without bounding the value of `rhs`.
`1304`	`1304`	`///`
`1305`	`1305`	/// If `rhs` is larger or equal to the number of bits in `self`,
`1306`	`1306`	/// the entire value is shifted out, and `0` is returned.
`@@ -1423,7 +1423,7 @@ macro_rules! int_impl {`
`1423`	`1423`	`}`
`1424`	`1424`	`}`
`1425`	`1425`
`1426`		- /// Unbounded shift right. Computes `self >> rhs`, without bounding the value of `rhs`
	`1426`	+ /// Unbounded shift right. Computes `self >> rhs`, without bounding the value of `rhs`.
`1427`	`1427`	`///`
`1428`	`1428`	/// If `rhs` is larger or equal to the number of bits in `self`,
`1429`	`1429`	/// the entire value is shifted out, which yields `0` for a positive number,
`@@ -2389,7 +2389,7 @@ macro_rules! int_impl {`
`2389`	`2389`	`(res, overflowed ^ (rhs < 0))`
`2390`	`2390`	`}`
`2391`	`2391`
`2392`		- /// Calculates `self` - `rhs`
	`2392`	+ /// Calculates `self` - `rhs`.
`2393`	`2393`	`///`
`2394`	`2394`	`/// Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow`
`2395`	`2395`	`/// would occur. If an overflow would have occurred then the wrapped value is returned.`
`@@ -2470,7 +2470,7 @@ macro_rules! int_impl {`
`2470`	`2470`	`(c, b != d)`
`2471`	`2471`	`}`
`2472`	`2472`
`2473`		- /// Calculates `self` - `rhs` with an unsigned `rhs`
	`2473`	+ /// Calculates `self` - `rhs` with an unsigned `rhs`.
`2474`	`2474`	`///`
`2475`	`2475`	`/// Returns a tuple of the subtraction along with a boolean indicating`
`2476`	`2476`	`/// whether an arithmetic overflow would occur. If an overflow would`