Browse Source

Add word of caution about `Float` and `no_std`

Vinzent Steinberg 7 years ago
parent
commit
b7d2a99d09
1 changed files with 5 additions and 1 deletions
  1. 5 1
      traits/src/float.rs

+ 5 - 1
traits/src/float.rs

@@ -10,7 +10,11 @@ use {ToPrimitive, Num, NumCast};
 // FIXME: these doctests aren't actually helpful, because they're using and
 // testing the inherent methods directly, not going through `Float`.
 
-/// Floating point operations that work with `std`.
+/// Floating point operations.
+///
+/// Please note that some methods are disabled for `no_std`. If you implement it
+/// only for `no_std`, the build will fail if anyone else in the dependency
+/// graph enables `num-traits/std`.
 pub trait Float
     : Num
     + Copy