Skip to content

Commit

Permalink
docs(cli): documentation tweaks (#5458)
Browse files Browse the repository at this point in the history
  • Loading branch information
iuioiua authored Jul 17, 2024
1 parent 38dbb1a commit 317a0d8
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions cli/parse_args.ts
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ type Dedot<TKey extends string, TValue> = TKey extends

type ValueOf<TValue> = TValue[keyof TValue];

/** The value returned from `parseArgs`. */
/** The value returned from {@linkcode parseArgs}. */
export type Args<
// deno-lint-ignore no-explicit-any
TArgs extends Record<string, unknown> = Record<string, any>,
Expand All @@ -260,7 +260,7 @@ type DoubleDash = {
"--"?: Array<string>;
};

/** The options for the `parseArgs` call. */
/** Options for {@linkcode parseArgs}. */
export interface ParseOptions<
TBooleans extends BooleanType = BooleanType,
TStrings extends StringType = StringType,
Expand Down Expand Up @@ -435,12 +435,12 @@ const FLAG_REGEXP =
* considered a key-value pair. Any arguments which could not be parsed are
* available in the `_` property of the returned object.
*
* By default, the flags module tries to determine the type of all arguments
* automatically and the return type of the `parseArgs` method will have an index
* By default, this module tries to determine the type of all arguments
* automatically and the return type of this function will have an index
* signature with `any` as value (`{ [x: string]: any }`).
*
* If the `string`, `boolean` or `collect` option is set, the return value of
* the `parseArgs` method will be fully typed and the index signature of the return
* this function will be fully typed and the index signature of the return
* type will change to `{ [x: string]: unknown }`.
*
* Any arguments after `'--'` will not be parsed and will end up in `parsedArgs._`.
Expand Down

0 comments on commit 317a0d8

Please sign in to comment.