Skip to content

Commit 75a631d

Browse files
authored
Rollup merge of #94015 - GuillaumeGomez:check-option, r=notriddle
rustdoc --check option documentation Part of #92763. r? ```@notriddle```
2 parents 9a42121 + 590ca7e commit 75a631d

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

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

+14-1
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ the same CSS rules as the official `light` theme.
381381
`--check-theme` flag, it discards all other flags and only performs the CSS rule
382382
comparison operation.
383383

384-
### `--crate-version`: control the crate version
384+
## `--crate-version`: control the crate version
385385

386386
Using this flag looks like this:
387387

@@ -418,9 +418,22 @@ Rustdoc only supports Rust source code and Markdown input formats. If the
418418
file ends in `.md` or `.markdown`, `rustdoc` treats it as a Markdown file.
419419
Otherwise, it assumes that the input file is Rust.
420420

421+
# Unstable command line arguments
422+
421423
## `--nocapture`
422424

423425
When this flag is used with `--test`, the output (stdout and stderr) of your tests won't be
424426
captured by rustdoc. Instead, the output will be directed to your terminal,
425427
as if you had run the test executable manually. This is especially useful
426428
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)