Skip to content

Commit dadeae8

Browse files
committed
Auto merge of #10166 - ehuss:scrape-examples-unstable-doc, r=alexcrichton
Move scrape-examples docs to correct section. This was erroneously put in the stabilized section.
2 parents c7db299 + 6079746 commit dadeae8

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

src/doc/src/reference/unstable.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1218,6 +1218,20 @@ filename = "007bar"
12181218
path = "src/main.rs"
12191219
```
12201220

1221+
### scrape-examples
1222+
1223+
* RFC: [#3123](https://github.com/rust-lang/rfcs/pull/3123)
1224+
* Tracking Issue: [#9910](https://github.com/rust-lang/cargo/issues/9910)
1225+
1226+
The `-Z rustdoc-scrape-examples` argument tells Rustdoc to search crates in the current workspace
1227+
for calls to functions. Those call-sites are then included as documentation. The flag can take an
1228+
argument of `all` or `examples` which configures which crate in the workspace to analyze for examples.
1229+
For instance:
1230+
1231+
```
1232+
cargo doc -Z unstable-options -Z rustdoc-scrape-examples=examples
1233+
```
1234+
12211235
## Stabilized and removed features
12221236

12231237
### Compile progress
@@ -1378,17 +1392,3 @@ Custom named profiles have been stabilized in the 1.57 release. See the
13781392
Support for generating a future-incompat report has been stabilized
13791393
in the 1.59 release. See the [future incompat report chapter](future-incompat-report.md)
13801394
for more information.
1381-
1382-
### scrape-examples
1383-
1384-
* RFC: [#3123](https://github.com/rust-lang/rfcs/pull/3123)
1385-
* Tracking Issue: [#9910](https://github.com/rust-lang/cargo/issues/9910)
1386-
1387-
The `-Z rustdoc-scrape-examples` argument tells Rustdoc to search crates in the current workspace
1388-
for calls to functions. Those call-sites are then included as documentation. The flag can take an
1389-
argument of `all` or `examples` which configures which crate in the workspace to analyze for examples.
1390-
For instance:
1391-
1392-
```
1393-
cargo doc -Z unstable-options -Z rustdoc-scrape-examples=examples
1394-
```

0 commit comments

Comments
 (0)