-
Notifications
You must be signed in to change notification settings - Fork 5.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
suggestion: expand the functionality of deno doc --lint
#23937
Comments
I talked with @kt3k; he also thinks this might be a good idea. |
I think we might want to consider moving export function parseArgs<
TArgs extends Values<
TBooleans,
TStrings,
TCollectable,
TNegatable,
TDefaults,
TAliases
>,
TDoubleDash extends boolean | undefined = undefined,
TBooleans extends BooleanType = undefined,
TStrings extends StringType = undefined,
TCollectable extends Collectable = undefined,
TNegatable extends Negatable = undefined,
TDefaults extends Record<string, unknown> | undefined = undefined,
TAliases extends Aliases<TAliasArgNames, TAliasNames> | undefined = undefined,
TAliasArgNames extends string = string,
TAliasNames extends string = string,
>(
args: string[],
{
"--": doubleDash = false,
alias = {} as NonNullable<TAliases>,
boolean = false,
default: defaults = {} as TDefaults & Defaults<TBooleans, TStrings>,
stopEarly = false,
string = [],
collect = [],
negatable = [],
unknown: unknownFn = (i: string): unknown => i,
}: ParseOptions<
TBooleans,
TStrings,
TCollectable,
TNegatable,
TDefaults,
TAliases,
TDoubleDash
> = {},
): Args<TArgs, TDoubleDash> { |
I guess being forced to document that isn't so bad now that I think about it more. |
This will be a bit much though. For example, in some of my projects I wouldn't have time to go through adding examples for everything:
It would be nice to be able to be able to opt-out of certain rules and |
I think it's possible |
Perhaps, running code snippets can be done with |
Such as:
@typeParam
or@template
tag.@param
,@arg
, or@argument
tag.@returns
tag.@example
tag.This would significantly improve the quality of package documentation. We currently compensate for this missing functionality in the Standard Library by implementing our own doc checker.
If approved, I'd happily help with these efforts.
CC @dsherret
The text was updated successfully, but these errors were encountered: