Skip to content

Commit 58c3f50

Browse files
committed
clarify deletion behavior of output-dir (closes #13896)
1 parent 9c6d652 commit 58c3f50

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

src/command/render/cmd.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export const renderCommand = new Command()
3737
)
3838
.option(
3939
"--output-dir",
40-
"Write output to DIR (path is input/project relative)",
40+
"Write output to DIR, which is first deleted (path is input/project relative)",
4141
)
4242
.option(
4343
"-M, --metadata",
@@ -89,7 +89,7 @@ export const renderCommand = new Command()
8989
)
9090
.option(
9191
"--no-clean",
92-
"Do not clean project output-dir prior to render",
92+
"Do not delete output-dir prior to render",
9393
)
9494
.option(
9595
"--debug",

src/resources/schema/project.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,11 @@
2424
- `project`: Use the root directory of the project.
2525
output-dir:
2626
path:
27-
description: "Output directory"
27+
description:
28+
short: "Output directory"
29+
long: >
30+
The directory in which all outputs are placed. If a directory with this name
31+
already exists, it will be deleted and replaced with a new directory.
2832
lib-dir:
2933
path:
3034
description: "HTML library (JS/CSS/etc.) directory"

0 commit comments

Comments
 (0)