Skip to content

Commit

Permalink
Clarify rotate_{left,right} docs
Browse files Browse the repository at this point in the history
I wondered what the `<<!` operator is although the exclamation mark was
only the end of the sentence.
  • Loading branch information
tbu- committed Feb 26, 2019
1 parent ea43c3c commit 998896c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
8 changes: 4 additions & 4 deletions src/libcore/num/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ $EndFeature, "
concat!("Shifts the bits to the left by a specified amount, `n`,
wrapping the truncated bits to the end of the resulting integer.
Please note this isn't the same operation as `<<`!
Please note this isn't the same operation as the `<<` shifting operator!
# Examples
Expand All @@ -370,7 +370,7 @@ assert_eq!(n.rotate_left(", $rot, "), m);
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn't the same operation as `>>`!
Please note this isn't the same operation as the `>>` shifting operator!
# Examples
Expand Down Expand Up @@ -2300,7 +2300,7 @@ assert_eq!(n.trailing_zeros(), 3);", $EndFeature, "
concat!("Shifts the bits to the left by a specified amount, `n`,
wrapping the truncated bits to the end of the resulting integer.
Please note this isn't the same operation as `<<`!
Please note this isn't the same operation as the `<<` shifting operator!
# Examples
Expand All @@ -2324,7 +2324,7 @@ assert_eq!(n.rotate_left(", $rot, "), m);
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn't the same operation as `>>`!
Please note this isn't the same operation as the `>>` shifting operator!
# Examples
Expand Down
6 changes: 4 additions & 2 deletions src/libcore/num/wrapping.rs
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,8 @@ assert_eq!(n.trailing_zeros(), 3);
/// wrapping the truncated bits to the end of the resulting
/// integer.
///
/// Please note this isn't the same operation as `>>`!
/// Please note this isn't the same operation as the `>>` shifting
/// operator!
///
/// # Examples
///
Expand All @@ -454,7 +455,8 @@ assert_eq!(n.trailing_zeros(), 3);
/// wrapping the truncated bits to the beginning of the resulting
/// integer.
///
/// Please note this isn't the same operation as `<<`!
/// Please note this isn't the same operation as the `<<` shifting
/// operator!
///
/// # Examples
///
Expand Down

0 comments on commit 998896c

Please sign in to comment.