Skip to content

Commit 9f89bed

Browse files
committed
docs: Correct excludeExternals description
Resolves #927
1 parent 68399a7 commit 9f89bed

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

src/lib/utils/options/sources/typedoc.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,12 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
3535
help:
3636
"Define patterns for files that should be considered being external.",
3737
type: ParameterType.Array,
38+
defaultValue: ["**/node_modules/**"],
3839
});
3940
options.addDeclaration({
4041
name: "excludeExternals",
41-
help:
42-
"Prevent externally resolved TypeScript files from being documented.",
42+
help: "Prevent externally resolved symbols from being documented.",
4343
type: ParameterType.Boolean,
44-
defaultValue: true,
4544
});
4645
options.addDeclaration({
4746
name: "excludeNotDocumented",

0 commit comments

Comments
 (0)