Skip to content

Commit ba4815e

Browse files
authored
docs: fix formatting nits in comments
1 parent 9549cf9 commit ba4815e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

utils.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ const {
2424
* Determines if the argument may be used as an option value.
2525
* NB: We are choosing not to accept option-ish arguments.
2626
* @example
27-
* isOptionValue('V']) // returns true
27+
* isOptionValue('V') // returns true
2828
* isOptionValue('-v') // returns false
2929
* isOptionValue('--foo') // returns false
3030
* isOptionValue(undefined) // returns false
@@ -58,7 +58,7 @@ function isLoneShortOption(arg) {
5858
* isLoneLongOption('a') // returns false
5959
* isLoneLongOption('-a') // returns false
6060
* isLoneLongOption('--foo) // returns true
61-
* isLoneLongOption('--foo=bar) // returns false
61+
* isLoneLongOption('--foo=bar') // returns false
6262
*/
6363
function isLoneLongOption(arg) {
6464
return arg.length > 2 &&
@@ -67,10 +67,10 @@ function isLoneLongOption(arg) {
6767
}
6868

6969
/**
70-
* Determines if `arg` is a long option and value in same argument.
70+
* Determines if `arg` is a long option and value in the same argument.
7171
* @example
7272
* isLongOptionAndValue('--foo) // returns false
73-
* isLongOptionAndValue('--foo=bar) // returns true
73+
* isLongOptionAndValue('--foo=bar') // returns true
7474
*/
7575
function isLongOptionAndValue(arg) {
7676
return arg.length > 2 &&
@@ -133,11 +133,11 @@ function isShortOptionAndValue(arg, options) {
133133

134134
/**
135135
* Find the long option associated with a short option. Looks for a configured
136-
* `short` and returns the short option itself if long option not found.
136+
* `short` and returns the short option itself if a long option is not found.
137137
* @example
138138
* findLongOptionForShort('a', {}) // returns 'a'
139139
* findLongOptionForShort('b', {
140-
* options: { bar: { short: 'b' }}
140+
* options: { bar: { short: 'b' } }
141141
* }) // returns 'bar'
142142
*/
143143
function findLongOptionForShort(shortOption, options) {

0 commit comments

Comments
 (0)