note relation of next_multiple_of and prev_multiple_of

rust-num · Feb 23, 2019 · 7f88fde · 7f88fde
1 parent 93176f5
commit 7f88fde
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -195,6 +195,10 @@ pub trait Integer: Sized + Num + PartialOrd + Ord + Eq {
 
     /// Rounds up to nearest multiple of argument.
     ///
+    /// # Notes
+    ///
+    /// For signed types, `a.next_multiple_of(b) = a.prev_multiple_of(b.neg())`.
+    ///
     /// # Examples
     ///
     /// ~~~
@@ -216,6 +220,10 @@ pub trait Integer: Sized + Num + PartialOrd + Ord + Eq {
 
     /// Rounds down to nearest multiple of argument.
     ///
+    /// # Notes
+    ///
+    /// For signed types, `a.prev_multiple_of(b) = a.next_multiple_of(b.neg())`.
+    ///
     /// # Examples
     ///
     /// ~~~