Skip to content

Commit 590ca7e

Browse files
Add documentation for rustdoc --check option
1 parent 41a0f8c commit 590ca7e

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/doc/rustdoc/src/command-line-arguments.md

+11
Original file line numberDiff line numberDiff line change
@@ -426,3 +426,14 @@ When this flag is used with `--test`, the output (stdout and stderr) of your tes
426426
captured by rustdoc. Instead, the output will be directed to your terminal,
427427
as if you had run the test executable manually. This is especially useful
428428
for debugging your tests!
429+
430+
## `--check`
431+
432+
When this flag is supplied, rustdoc will type check and lint your code, but will not generate any
433+
documentation or run your doctests.
434+
435+
Using this flag looks like:
436+
437+
```bash
438+
rustdoc -Z unstable-options --check src/lib.rs
439+
```

0 commit comments

Comments
 (0)