From 6079746278bfe6859182e7cbc8ad1885d841924b Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Sat, 4 Dec 2021 17:58:35 -0800 Subject: [PATCH] Move scrape-examples docs to correct section. This was erroneously put in the stabilized section. --- src/doc/src/reference/unstable.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/src/doc/src/reference/unstable.md b/src/doc/src/reference/unstable.md index ec26f31d2cd..19371a79cc8 100644 --- a/src/doc/src/reference/unstable.md +++ b/src/doc/src/reference/unstable.md @@ -1218,6 +1218,20 @@ filename = "007bar" path = "src/main.rs" ``` +### scrape-examples + +* RFC: [#3123](https://github.com/rust-lang/rfcs/pull/3123) +* Tracking Issue: [#9910](https://github.com/rust-lang/cargo/issues/9910) + +The `-Z rustdoc-scrape-examples` argument tells Rustdoc to search crates in the current workspace +for calls to functions. Those call-sites are then included as documentation. The flag can take an +argument of `all` or `examples` which configures which crate in the workspace to analyze for examples. +For instance: + +``` +cargo doc -Z unstable-options -Z rustdoc-scrape-examples=examples +``` + ## Stabilized and removed features ### Compile progress @@ -1378,17 +1392,3 @@ Custom named profiles have been stabilized in the 1.57 release. See the Support for generating a future-incompat report has been stabilized in the 1.59 release. See the [future incompat report chapter](future-incompat-report.md) for more information. - -### scrape-examples - -* RFC: [#3123](https://github.com/rust-lang/rfcs/pull/3123) -* Tracking Issue: [#9910](https://github.com/rust-lang/cargo/issues/9910) - -The `-Z rustdoc-scrape-examples` argument tells Rustdoc to search crates in the current workspace -for calls to functions. Those call-sites are then included as documentation. The flag can take an -argument of `all` or `examples` which configures which crate in the workspace to analyze for examples. -For instance: - -``` -cargo doc -Z unstable-options -Z rustdoc-scrape-examples=examples -```