Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tracking Issue for doc --scrape-examples #9910

Open
willcrichton opened this issue Sep 14, 2021 · 0 comments
Open

Tracking Issue for doc --scrape-examples #9910

willcrichton opened this issue Sep 14, 2021 · 0 comments
Labels
C-tracking-issue Category: A tracking issue for something unstable. S-needs-mentor Status: Issue or feature is accepted, but needs a team member to commit to helping and reviewing. S-waiting-on-feedback Status: An implemented feature is waiting on community feedback for bugs or design concerns. Z-scrape-examples Nightly: rustdoc scrape examples
Projects

Comments

@willcrichton
Copy link
Contributor

willcrichton commented Sep 14, 2021

Summary

RFC: #3123

Documentation:
https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#scrape-examples
https://doc.rust-lang.org/nightly/rustdoc/scraped-examples.html
Issues: Z-scrape-examples Nightly: rustdoc 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

Implementation history

@willcrichton willcrichton added the C-tracking-issue Category: A tracking issue for something unstable. label Sep 14, 2021
@ehuss ehuss added the Z-scrape-examples Nightly: rustdoc scrape examples label Nov 6, 2021
@ehuss ehuss added this to In Progress in Roadmap Jul 13, 2022
@ehuss ehuss added S-needs-mentor Status: Issue or feature is accepted, but needs a team member to commit to helping and reviewing. S-waiting-on-feedback Status: An implemented feature is waiting on community feedback for bugs or design concerns. labels Apr 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-tracking-issue Category: A tracking issue for something unstable. S-needs-mentor Status: Issue or feature is accepted, but needs a team member to commit to helping and reviewing. S-waiting-on-feedback Status: An implemented feature is waiting on community feedback for bugs or design concerns. Z-scrape-examples Nightly: rustdoc scrape examples
Projects
Status: In Progress
Roadmap
  
In Progress
Development

No branches or pull requests

2 participants