Skip to content

Commit

Permalink
docs: Correct excludeExternals description
Browse files Browse the repository at this point in the history
Resolves #927
  • Loading branch information
Gerrit0 committed Nov 26, 2020
1 parent 68399a7 commit 9f89bed
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions src/lib/utils/options/sources/typedoc.ts
Expand Up @@ -35,13 +35,12 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
help:
"Define patterns for files that should be considered being external.",
type: ParameterType.Array,
defaultValue: ["**/node_modules/**"],
});
options.addDeclaration({
name: "excludeExternals",
help:
"Prevent externally resolved TypeScript files from being documented.",
help: "Prevent externally resolved symbols from being documented.",
type: ParameterType.Boolean,
defaultValue: true,
});
options.addDeclaration({
name: "excludeNotDocumented",
Expand Down

0 comments on commit 9f89bed

Please sign in to comment.