Merge pull request #390 from cnrudd/develop

Small changes to doc comments
BenjaminVanRyseghem · Oct 17, 2018 · 61a426b · 61a426b
2 parents 8d72513 + 55e2821
commit 61a426b
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -7,6 +7,7 @@ Andrei Alecu https://github.com/andreialecu
 badplum (https://github.com/badplum)
 Benedikt Huss (https://github.com/ben305)
 Benjamin Van Ryseghem <benjamin@vanryseghem.com> (https://benjamin.vanryseghem.com)
+Colin Rudd (https://github.com/cnrudd)
 Dan Ristic (https://github.com/dristic)
 Dave Clayton (https://github.com/davedx)
 Dieter Luypaert (https://github.com/moeriki)

diff --git a/src/formatting.js b/src/formatting.js
@@ -473,9 +473,9 @@ function toFixed(value, precision) {
  *
  * @param {string} output - output being build in the process of formatting
  * @param {number} value - number being currently formatted
- * @param {boolean} optionalMantissa - `true` if the mantissa is omitted when it's only zeroes
+ * @param {boolean} optionalMantissa - if `true`, the mantissa is omitted when it's only zeroes
  * @param {number} precision - desired precision of the mantissa
- * @param {boolean} trim - desired precision of the mantissa
+ * @param {boolean} trim - if `true`, trailing zeroes are removed from the mantissa
  * @return {string}
  */
 function setMantissaPrecision(output, value, optionalMantissa, precision, trim) {