docs(package): document anchor slightly better

Author: jedwards1211

README.md

@@ -34,19 +34,19 @@ npm install mod-floor-ceiling
 
 ### `modFloor(value: number, modulus: number, anchor?: number = 0): number`
 
-Returns the greatest (closest to positive infinity) multiple of `modulus` that is `<= value`.
+Returns the greatest (closest to positive infinity) multiple of `modulus`, plus `anchor`, that is `<= value`.
 
 ### `modCeiling(value: number, modulus: number, anchor?: number = 0): number`
 
-Returns the least (closest to negative infinity) multiple of `modulus` that is `>= value`.
+Returns the least (closest to negative infinity) multiple of `modulus`, plus `anchor`, that is `>= value`.
 
 ### `modLower(value: number, modulus: number, anchor?: number = 0): number`
 
-Returns the greatest (closest to positive infinity) multiple of `modulus` that is `< value`.
+Returns the greatest (closest to positive infinity) multiple of `modulus`, plus `anchor`, that is `< value`.
 
 ### `modHigher(value: number, modulus: number, anchor?: number = 0): number`
 
-Returns the greatest (closest to positive infinity) multiple of `modulus` that is `> value`.
+Returns the greatest (closest to positive infinity) multiple of `modulus`, plus `anchor`, that is `> value`.
 
 ### What is `anchor`?
 

lib/index.js

@@ -3,7 +3,7 @@
  * @param {number} modulus - the modulus of division
  * @param {number} [anchor=0] - controls the offset of multiples of modulus.  For example, with a modulus of 3
  * and an anchor of 1, possible return values include -2, 1, 4, 7, etc.
- * @return the greatest (closest to positive infinity) multiple of modulus that is <= value.
+ * @return the greatest (closest to positive infinity) multiple of modulus, plus anchor, that is <= value.
  */
 function modFloor(value, modulus, anchor) {
   if (anchor) return anchor + modFloor(value - anchor, modulus)
@@ -17,7 +17,7 @@ function modFloor(value, modulus, anchor) {
  * @param {number} modulus - the modulus of division
  * @param {number} [anchor=0] - controls the offset of multiples of modulus.  For example, with a modulus of 3
  * and an anchor of 1, possible return values include -2, 1, 4, 7, etc.
- * @return the least (closest to negative infinity) multiple of modulus that is >= value.
+ * @return the least (closest to negative infinity) multiple of modulus, plus anchor, that is >= value.
  */
 function modCeiling(value, modulus, anchor) {
   if (anchor) return anchor + modCeiling(value - anchor, modulus)
@@ -33,7 +33,7 @@ function modCeiling(value, modulus, anchor) {
  * @param {number} modulus - the modulus of division
  * @param {number} [anchor=0] - controls the offset of multiples of modulus.  For example, with a modulus of 3
  * and an anchor of 1, possible return values include -2, 1, 4, 7, etc.
- * @return the greatest (closest to positive infinity) multiple of modulus that is < value.
+ * @return the greatest (closest to positive infinity) multiple of modulus, plus anchor, that is < value.
  */
 function modLower(value, modulus, anchor) {
   var result = modFloor(value, modulus, anchor)
@@ -45,7 +45,7 @@ function modLower(value, modulus, anchor) {
  * @param {number} modulus - the modulus of division
  * @param {number} [anchor=0] - controls the offset of multiples of modulus.  For example, with a modulus of 3
  * and an anchor of 1, possible return values include -2, 1, 4, 7, etc.
- * @return the least (closest to negative infinity) multiple of modulus that is > value.
+ * @return the least (closest to negative infinity) multiple of modulus, plus anchor, that is > value.
  */
 function modHigher(value, modulus, anchor) {
   var result = modCeiling(value, modulus, anchor)