diff options
| author | Will Crichton <wcrichto@cs.stanford.edu> | 2022-02-11 21:48:59 -0800 |
|---|---|---|
| committer | Will Crichton <wcrichto@cs.stanford.edu> | 2022-02-11 21:48:59 -0800 |
| commit | fbbcb089c52e6dce88600be36a1cc97884294d4f (patch) | |
| tree | f82d4a8451f0f28b1761630043cbea2191bc6bfd /src/doc/rustdoc | |
| parent | 0c292c9667f1b202a9150d58bdd2e89e3e803996 (diff) | |
| download | rust-fbbcb089c52e6dce88600be36a1cc97884294d4f.tar.gz rust-fbbcb089c52e6dce88600be36a1cc97884294d4f.zip | |
Add --scrape-tests flags so rustdoc can scrape examples from tests
Diffstat (limited to 'src/doc/rustdoc')
| -rw-r--r-- | src/doc/rustdoc/src/unstable-features.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/src/doc/rustdoc/src/unstable-features.md b/src/doc/rustdoc/src/unstable-features.md index d60be193bda..c7fd5ed6fcb 100644 --- a/src/doc/rustdoc/src/unstable-features.md +++ b/src/doc/rustdoc/src/unstable-features.md @@ -509,3 +509,6 @@ reverse-dependency like `examples/ex.rs` is given to rustdoc with the target crate being documented (`foobar`) and a path to output the calls (`output.calls`). Then, the generated calls file can be passed via `--with-examples` to the subsequent documentation of `foobar`. + +To scrape examples from test code, e.g. functions marked `#[test]`, then +add the `--scrape-tests` flag. |