Rollup merge of #94015 - GuillaumeGomez:check-option, r=notriddle
rustdoc --check option documentation Part of #92763. r? ```@notriddle```
This commit is contained in:
commit
75a631d4ba
1 changed files with 14 additions and 1 deletions
|
|
@ -381,7 +381,7 @@ the same CSS rules as the official `light` theme.
|
|||
`--check-theme` flag, it discards all other flags and only performs the CSS rule
|
||||
comparison operation.
|
||||
|
||||
### `--crate-version`: control the crate version
|
||||
## `--crate-version`: control the crate version
|
||||
|
||||
Using this flag looks like this:
|
||||
|
||||
|
|
@ -418,9 +418,22 @@ Rustdoc only supports Rust source code and Markdown input formats. If the
|
|||
file ends in `.md` or `.markdown`, `rustdoc` treats it as a Markdown file.
|
||||
Otherwise, it assumes that the input file is Rust.
|
||||
|
||||
# Unstable command line arguments
|
||||
|
||||
## `--nocapture`
|
||||
|
||||
When this flag is used with `--test`, the output (stdout and stderr) of your tests won't be
|
||||
captured by rustdoc. Instead, the output will be directed to your terminal,
|
||||
as if you had run the test executable manually. This is especially useful
|
||||
for debugging your tests!
|
||||
|
||||
## `--check`
|
||||
|
||||
When this flag is supplied, rustdoc will type check and lint your code, but will not generate any
|
||||
documentation or run your doctests.
|
||||
|
||||
Using this flag looks like:
|
||||
|
||||
```bash
|
||||
rustdoc -Z unstable-options --check src/lib.rs
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue