Skip to content

Commit fd20839

Browse files
Make docs more clear (rust-lang#15933)
`NB!` is extremely alien + not used anywhere else in repo (per github search). `Notes => Note`. At first thought was convention (written from perspective of the lint), but not seen anywhere else in repo (per github search). Implication: clearer docs Changes made from github web editor; no tests/checks performed. changelog: none
2 parents c6c71af + bab7519 commit fd20839

File tree

1 file changed

+3
-3
lines changed
  • clippy_lints/src/operators

1 file changed

+3
-3
lines changed

clippy_lints/src/operators/mod.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,7 @@ declare_clippy_lint! {
464464
declare_clippy_lint! {
465465
/// ### What it does
466466
/// Checks for statements of the form `(a - b) < f32::EPSILON` or
467-
/// `(a - b) < f64::EPSILON`. Notes the missing `.abs()`.
467+
/// `(a - b) < f64::EPSILON`. Note the missing `.abs()`.
468468
///
469469
/// ### Why is this bad?
470470
/// The code without `.abs()` is more likely to have a bug.
@@ -617,7 +617,7 @@ declare_clippy_lint! {
617617
/// println!("{within_tolerance}"); // true
618618
/// ```
619619
///
620-
/// NB! Do not use `f64::EPSILON` - while the error margin is often called "epsilon", this is
620+
/// NOTE: Do not use `f64::EPSILON` - while the error margin is often called "epsilon", this is
621621
/// a different use of the term that is not suitable for floating point equality comparison.
622622
/// Indeed, for the example above using `f64::EPSILON` as the allowed error would return `false`.
623623
///
@@ -680,7 +680,7 @@ declare_clippy_lint! {
680680
/// println!("{within_tolerance}"); // true
681681
/// ```
682682
///
683-
/// NB! Do not use `f64::EPSILON` - while the error margin is often called "epsilon", this is
683+
/// NOTE: Do not use `f64::EPSILON` - while the error margin is often called "epsilon", this is
684684
/// a different use of the term that is not suitable for floating point equality comparison.
685685
/// Indeed, for the example above using `f64::EPSILON` as the allowed error would return `false`.
686686
///

0 commit comments

Comments
 (0)