Skip to content

Commit 39551a0

Browse files
committed
Remove "(optional)" from doc blocks
1 parent ff2ce10 commit 39551a0

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

packages/cli/src/core/options/options.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,9 @@ export type OptionConfig<
118118
customType?: OptionCustomType<T>;
119119

120120
/**
121-
* The valid choices for the option (optional). If provided, the getter
122-
* will validate the value against the choices and, unless otherwise
123-
* specified, will use the choices when prompting.
121+
* The valid choices for the option. If provided, the getter will validate
122+
* the value against the choices and, unless otherwise specified, will use
123+
* the choices when prompting.
124124
*/
125125
choices?: OptionPrimitiveType<T>[];
126126

@@ -131,7 +131,7 @@ export type OptionConfig<
131131
string?: boolean;
132132

133133
/**
134-
* One or more aliases for the option (optional).
134+
* One or more aliases for the option.
135135
*/
136136
alias?: MaybeReadonly<TAlias[]>;
137137

@@ -142,22 +142,22 @@ export type OptionConfig<
142142

143143
/**
144144
* Whether the option is required. If `true`, the getter will throw an
145-
* error if no value is provided (optional).
145+
* error if no value is provided.
146146
*/
147147
required?: boolean;
148148

149149
/**
150-
* Other options that are required for this option to be used (optional).
150+
* Other options that are required for this option to be used.
151151
*/
152152
requires?: MaybeReadonly<string[]>;
153153

154154
/**
155-
* Other options that are mutually exclusive with this option (optional).
155+
* Other options that are mutually exclusive with this option.
156156
*/
157157
conflicts?: MaybeReadonly<string[]>;
158158

159159
/**
160-
* The autocomplete function (optional).
160+
* The autocomplete function.
161161
*/
162162
// TODO: Not implemented yet
163163
// autoComplete?: (input: string) => MaybePromise<string[]>;
@@ -167,25 +167,25 @@ export type OptionConfig<
167167
} & (
168168
| {
169169
/**
170-
* The number of arguments the option accepts (optional).
170+
* The number of arguments the option accepts.
171171
*/
172172
nargs?: undefined;
173173

174174
/**
175175
* The default value to use. This will be the initial value that the
176-
* getter prompt will show (optional).
176+
* getter prompt will show.
177177
*/
178178
default?: OptionPrimitiveType<T> | string;
179179
}
180180
| {
181181
/**
182-
* The number of arguments the option accepts (optional).
182+
* The number of arguments the option accepts.
183183
*/
184184
nargs: number;
185185

186186
/**
187187
* The default value to use. This will be the initial value that the
188-
* getter prompt will show (optional).
188+
* getter prompt will show.
189189
*/
190190
default?:
191191
| (OptionPrimitiveType<T> extends (infer T)[]

0 commit comments

Comments
 (0)