about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorMazdak Farrokhzad <twingoow@gmail.com>2018-12-16 14:08:39 +0100
committerGitHub <noreply@github.com>2018-12-16 14:08:39 +0100
commitcee0bddd0a4e0eb3ea8d7025f25ea95cb6a5c5ef (patch)
treea9d5de482562b0946ddd10d375446b7ed0880d4c /src/libstd
parenta777754c4d3dc88ac5a0e9e4dd9e5847779206c3 (diff)
parent967b1fc3b723117d57ff27417d811747b1bf1242 (diff)
downloadrust-cee0bddd0a4e0eb3ea8d7025f25ea95cb6a5c5ef.tar.gz
rust-cee0bddd0a4e0eb3ea8d7025f25ea95cb6a5c5ef.zip
Rollup merge of #56857 - tbu-:pr_doc_abssub, r=zackmdavis
Fix a small mistake regarding NaNs in a deprecation message

`max` on floats returns the other argument if one of them is NaN, which
would be `0.0` in this case. This is unlike the C functions `fdim` and
`fdimf` which return NaN if either of their arguments is NaN.

https://doc.rust-lang.org/1.31.0/std/primitive.f32.html#method.max
https://en.cppreference.com/w/c/numeric/math/fdim
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/f32.rs3
-rw-r--r--src/libstd/f64.rs3
2 files changed, 4 insertions, 2 deletions
diff --git a/src/libstd/f32.rs b/src/libstd/f32.rs
index 7d17aaf2f26..d0dd4d4adcb 100644
--- a/src/libstd/f32.rs
+++ b/src/libstd/f32.rs
@@ -550,7 +550,8 @@ impl f32 {
     #[inline]
     #[rustc_deprecated(since = "1.10.0",
                        reason = "you probably meant `(self - other).abs()`: \
-                                 this operation is `(self - other).max(0.0)` (also \
+                                 this operation is `(self - other).max(0.0)` \
+                                 except that `abs_sub` also propagates NaNs (also \
                                  known as `fdimf` in C). If you truly need the positive \
                                  difference, consider using that expression or the C function \
                                  `fdimf`, depending on how you wish to handle NaN (please consider \
diff --git a/src/libstd/f64.rs b/src/libstd/f64.rs
index c800763167f..9e627ec2042 100644
--- a/src/libstd/f64.rs
+++ b/src/libstd/f64.rs
@@ -491,7 +491,8 @@ impl f64 {
     #[inline]
     #[rustc_deprecated(since = "1.10.0",
                        reason = "you probably meant `(self - other).abs()`: \
-                                 this operation is `(self - other).max(0.0)` (also \
+                                 this operation is `(self - other).max(0.0)` \
+                                 except that `abs_sub` also propagates NaNs (also \
                                  known as `fdim` in C). If you truly need the positive \
                                  difference, consider using that expression or the C function \
                                  `fdim`, depending on how you wish to handle NaN (please consider \