1
Fork 0

Don't stutter in operator descriptions #29365

This commit is contained in:
Phil Ellison 2017-03-25 09:03:22 +00:00
parent 49c67bd632
commit 8b92255b64

View file

@ -196,7 +196,7 @@ pub trait Drop {
fn drop(&mut self); fn drop(&mut self);
} }
/// The `Add` trait is used to specify the functionality of `+`. /// The addition operator `+`.
/// ///
/// # Examples /// # Examples
/// ///
@ -269,7 +269,7 @@ macro_rules! add_impl {
add_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 } add_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 }
/// The `Sub` trait is used to specify the functionality of `-`. /// The subtraction operator `-`.
/// ///
/// # Examples /// # Examples
/// ///
@ -342,7 +342,7 @@ macro_rules! sub_impl {
sub_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 } sub_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 }
/// The `Mul` trait is used to specify the functionality of `*`. /// The multiplication operator `*`.
/// ///
/// # Examples /// # Examples
/// ///
@ -464,7 +464,7 @@ macro_rules! mul_impl {
mul_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 } mul_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 }
/// The `Div` trait is used to specify the functionality of `/`. /// The division operator `/`.
/// ///
/// # Examples /// # Examples
/// ///
@ -609,7 +609,7 @@ macro_rules! div_impl_float {
div_impl_float! { f32 f64 } div_impl_float! { f32 f64 }
/// The `Rem` trait is used to specify the functionality of `%`. /// The remainder operator `%`.
/// ///
/// # Examples /// # Examples
/// ///
@ -689,7 +689,7 @@ macro_rules! rem_impl_float {
rem_impl_float! { f32 f64 } rem_impl_float! { f32 f64 }
/// The `Neg` trait is used to specify the functionality of unary `-`. /// The unary negation operator `-`.
/// ///
/// # Examples /// # Examples
/// ///
@ -768,7 +768,7 @@ macro_rules! neg_impl_unsigned {
// neg_impl_unsigned! { usize u8 u16 u32 u64 } // neg_impl_unsigned! { usize u8 u16 u32 u64 }
neg_impl_numeric! { isize i8 i16 i32 i64 i128 f32 f64 } neg_impl_numeric! { isize i8 i16 i32 i64 i128 f32 f64 }
/// The `Not` trait is used to specify the functionality of unary `!`. /// The unary logical negation operator `!`.
/// ///
/// # Examples /// # Examples
/// ///
@ -826,7 +826,7 @@ macro_rules! not_impl {
not_impl! { bool usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 } not_impl! { bool usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }
/// The `BitAnd` trait is used to specify the functionality of `&`. /// The bitwise AND operator `&`.
/// ///
/// # Examples /// # Examples
/// ///
@ -909,7 +909,7 @@ macro_rules! bitand_impl {
bitand_impl! { bool usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 } bitand_impl! { bool usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }
/// The `BitOr` trait is used to specify the functionality of `|`. /// The bitwise OR operator `|`.
/// ///
/// # Examples /// # Examples
/// ///
@ -992,7 +992,7 @@ macro_rules! bitor_impl {
bitor_impl! { bool usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 } bitor_impl! { bool usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }
/// The `BitXor` trait is used to specify the functionality of `^`. /// The bitwise XOR operator `^`.
/// ///
/// # Examples /// # Examples
/// ///
@ -1078,7 +1078,7 @@ macro_rules! bitxor_impl {
bitxor_impl! { bool usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 } bitxor_impl! { bool usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }
/// The `Shl` trait is used to specify the functionality of `<<`. /// The left shift operator `<<`.
/// ///
/// # Examples /// # Examples
/// ///
@ -1181,7 +1181,7 @@ macro_rules! shl_impl_all {
shl_impl_all! { u8 u16 u32 u64 u128 usize i8 i16 i32 i64 isize i128 } shl_impl_all! { u8 u16 u32 u64 u128 usize i8 i16 i32 i64 isize i128 }
/// The `Shr` trait is used to specify the functionality of `>>`. /// The right shift operator `>>`.
/// ///
/// # Examples /// # Examples
/// ///
@ -1284,7 +1284,7 @@ macro_rules! shr_impl_all {
shr_impl_all! { u8 u16 u32 u64 u128 usize i8 i16 i32 i64 i128 isize } shr_impl_all! { u8 u16 u32 u64 u128 usize i8 i16 i32 i64 i128 isize }
/// The `AddAssign` trait is used to specify the functionality of `+=`. /// The addition assignment operator `+=`.
/// ///
/// # Examples /// # Examples
/// ///
@ -1340,7 +1340,7 @@ macro_rules! add_assign_impl {
add_assign_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 } add_assign_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 }
/// The `SubAssign` trait is used to specify the functionality of `-=`. /// The subtraction assignment operator `-=`.
/// ///
/// # Examples /// # Examples
/// ///
@ -1396,7 +1396,7 @@ macro_rules! sub_assign_impl {
sub_assign_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 } sub_assign_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 }
/// The `MulAssign` trait is used to specify the functionality of `*=`. /// The multiplication assignment operator `*=`.
/// ///
/// # Examples /// # Examples
/// ///
@ -1441,7 +1441,7 @@ macro_rules! mul_assign_impl {
mul_assign_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 } mul_assign_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 }
/// The `DivAssign` trait is used to specify the functionality of `/=`. /// The division assignment operator `/=`.
/// ///
/// # Examples /// # Examples
/// ///
@ -1485,7 +1485,7 @@ macro_rules! div_assign_impl {
div_assign_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 } div_assign_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 }
/// The `RemAssign` trait is used to specify the functionality of `%=`. /// The remainder assignment operator `%=`.
/// ///
/// # Examples /// # Examples
/// ///
@ -1529,7 +1529,7 @@ macro_rules! rem_assign_impl {
rem_assign_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 } rem_assign_impl! { usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 f32 f64 }
/// The `BitAndAssign` trait is used to specify the functionality of `&=`. /// The bitwise AND assignment operator `&=`.
/// ///
/// # Examples /// # Examples
/// ///
@ -1615,7 +1615,7 @@ macro_rules! bitand_assign_impl {
bitand_assign_impl! { bool usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 } bitand_assign_impl! { bool usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }
/// The `BitOrAssign` trait is used to specify the functionality of `|=`. /// The bitwise OR assignment operator `|=`.
/// ///
/// # Examples /// # Examples
/// ///
@ -1659,7 +1659,7 @@ macro_rules! bitor_assign_impl {
bitor_assign_impl! { bool usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 } bitor_assign_impl! { bool usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }
/// The `BitXorAssign` trait is used to specify the functionality of `^=`. /// The bitwise XOR assignment operator `^=`.
/// ///
/// # Examples /// # Examples
/// ///
@ -1703,7 +1703,7 @@ macro_rules! bitxor_assign_impl {
bitxor_assign_impl! { bool usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 } bitxor_assign_impl! { bool usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 }
/// The `ShlAssign` trait is used to specify the functionality of `<<=`. /// The left shift assignment operator `<<=`.
/// ///
/// # Examples /// # Examples
/// ///
@ -1768,7 +1768,7 @@ macro_rules! shl_assign_impl_all {
shl_assign_impl_all! { u8 u16 u32 u64 u128 usize i8 i16 i32 i64 i128 isize } shl_assign_impl_all! { u8 u16 u32 u64 u128 usize i8 i16 i32 i64 i128 isize }
/// The `ShrAssign` trait is used to specify the functionality of `>>=`. /// The right shift assignment operator `>>=`.
/// ///
/// # Examples /// # Examples
/// ///