Skip to content

Commit 42c549c

Browse files
fix --check explanation (#19)
* --check expects string * --checkLevel has `Hint` option * Improve description --------- Co-authored-by: carsakiller <[email protected]>
1 parent 5cd71dd commit 42c549c

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/content/wiki/usage.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,10 +127,11 @@ line and immediately exit.
127127

128128
### --check
129129

130-
**Type:** `boolean`
130+
**Type:** `string`
131+
132+
Perform a "diagnosis report" where the results of the diagnosis are written to the [logpath](/wiki/faq/#where-can-i-find-the-log-file).
131133

132-
Perform a "diagnosis report" where the results of the diagnosis are written to a
133-
file.
134+
Example: `--check=C:\Users\Me\path\to\workspace`
134135

135136
### --checklevel
136137

@@ -145,6 +146,7 @@ file. Options include, in order of priority:
145146
- Error
146147
- Warning
147148
- Information
149+
- Hint
148150

149151
Example: `--checklevel=Information`
150152

0 commit comments

Comments
 (0)