cargo icon indicating copy to clipboard operation
cargo copied to clipboard

Tracking Issue for doc --scrape-examples

Open willcrichton opened this issue 4 years ago • 0 comments

Summary

RFC: #3123 Implementation: #9525 (see also #85833 in rustc) Documentation: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#scrape-examples https://doc.rust-lang.org/nightly/rustdoc/scraped-examples.html Issues: https://github.com/rust-lang/cargo/labels/Z-scrape-examples

This feature adds Cargo support for the new rustdoc --scrape-examples flag. The --scrape-examples feature searches crates to find call-sites for functions, and then includes those call-sites as examples when documenting the called function. The Cargo integration is responsible for calling the analysis step (generating a call-locations.json), and then passing that file to rustdoc.

Unresolved issues

None right now

Future extensions

None expected right now

willcrichton avatar Sep 14 '21 17:09 willcrichton