Skip to content

Commit 977f81f

Browse files
BryanBryan
authored andcommitted
JSDoc grammar fixes
1 parent 3e03962 commit 977f81f

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

docs/content/release_notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* specialFractions
1717
* thousandsSeparator
1818
* Function behavior has changed.
19-
* Passing a value which cannot will yield Number.NaN.
19+
* Passing a value which cannot be parsed will yield Number.NaN.
2020
* Passing an invalid unit code will yield Number.NaN.
2121
* A formal enumeration, called UnitCode, was added.
2222

docs/content/sdk/lib-utilities-format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
| value | <code>Number</code> | |
6060
| unitCode | <code>String</code> | |
6161
| [fractionSeparator] | <code>String</code> | Can be zero or one character in length. If invalid or omitted, a decimal notation is used. If non-decimal, then fractional notation is used (assuming supported by unit code). |
62-
| [specialFractions] | <code>Boolean</code> | If fractional notation is used, indicates is "special" factor (i.e. denominator) is used to calculate numerator. |
62+
| [specialFractions] | <code>Boolean</code> | If fractional notation is used, indicates if the "special" factor (i.e. denominator) is used to calculate numerator. |
6363
| [thousandsSeparator] | <code>String</code> | Can be zero or one character in length. If invalid or omitted, a zero-length string is used. |
6464
| [useParenthesis] | <code>Boolean</code> | If true, negative values will be represented with parenthesis (instead of a leading minus sign). |
6565

docs/content/sdk/lib-utilities-parse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
| value | <code>String</code> \| <code>Number</code> | |
1717
| unitCode | <code>String</code> | |
1818
| [fractionSeparator] | <code>String</code> | Can be zero or one character in length. If invalid or omitted, the separator will be inferred based on the value being parsed. |
19-
| [specialFractions] | <code>Boolean</code> | If fractional notation is used, indicates is "special" factor (i.e. denominator) was used to calculate the numerator of the value being parsed. |
19+
| [specialFractions] | <code>Boolean</code> | If fractional notation is used, indicates if the "special" factor (i.e. denominator) was used to calculate the numerator of the value being parsed. |
2020
| [thousandsSeparator] | <code>String</code> | Can be zero or one character in length. If invalid or omitted, the parameter will be ignored. |
2121

2222
>Converts a string-formatted price into a number. If the value cannot be parsed,

lib/utilities/format/price.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ module.exports = (() => {
3737
* @param {Number} value
3838
* @param {String} unitCode
3939
* @param {String=} fractionSeparator - Can be zero or one character in length. If invalid or omitted, a decimal notation is used. If non-decimal, then fractional notation is used (assuming supported by unit code).
40-
* @param {Boolean=} specialFractions - If fractional notation is used, indicates is "special" factor (i.e. denominator) is used to calculate numerator.
40+
* @param {Boolean=} specialFractions - If fractional notation is used, indicates if the "special" factor (i.e. denominator) is used to calculate numerator.
4141
* @param {String=} thousandsSeparator - Can be zero or one character in length. If invalid or omitted, a zero-length string is used.
4242
* @param {Boolean=} useParenthesis - If true, negative values will be represented with parenthesis (instead of a leading minus sign).
4343
* @returns {String}

lib/utilities/parse/price.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ module.exports = (() => {
2424
* @param {String|Number} value
2525
* @param {String} unitCode
2626
* @param {String=} fractionSeparator - Can be zero or one character in length. If invalid or omitted, the separator will be inferred based on the value being parsed.
27-
* @param {Boolean=} specialFractions - If fractional notation is used, indicates is "special" factor (i.e. denominator) was used to calculate the numerator of the value being parsed.
27+
* @param {Boolean=} specialFractions - If fractional notation is used, indicates if the "special" factor (i.e. denominator) was used to calculate the numerator of the value being parsed.
2828
* @param {String=} thousandsSeparator - Can be zero or one character in length. If invalid or omitted, the parameter will be ignored.
2929
* @returns {Number}
3030
*/

0 commit comments

Comments
 (0)