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.

Sign up for GitHub

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

Jump to bottom

Document new default of -Zrustdoc-scrape-examples #11424

Closed
weihanglo opened this issue Nov 25, 2022 · 2 comments · Fixed by #11425
Closed

Document new default of -Zrustdoc-scrape-examples #11424

weihanglo opened this issue Nov 25, 2022 · 2 comments · Fixed by #11425
Labels
A-documenting-cargo-itself Area: Cargo's documentation C-enhancement Category: enhancement Z-scrape-examples Nightly: rustdoc scrape examples

Comments

@weihanglo
Copy link
Member

Problem

#10343 introduces new behaviours for -Zrustdoc-scrape-examples, specifically, scraping examples by default under some circumstances. It would be helpful if the unstable doc can reflect this change a bit.

Proposed Solution

Update https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#scrape-examples

Notes

No response
@weihanglo weihanglo added A-documenting-cargo-itself Area: Cargo's documentation C-enhancement Category: enhancement Z-scrape-examples Nightly: rustdoc scrape examples labels Nov 25, 2022
@weihanglo
Copy link
Member Author

cc @willcrichton, could you help this?

@willcrichton
Copy link
Contributor

Yes I'll take care of it.

@willcrichton willcrichton mentioned this issue Nov 26, 2022
Merged
@bors bors closed this as completed in 1382b44 Nov 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-documenting-cargo-itself Area: Cargo's documentation C-enhancement Category: enhancement Z-scrape-examples Nightly: rustdoc scrape examples
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update documentation for -Zrustdoc-scrape-examples in the Cargo Book willcrichton/cargo
2 participants
@willcrichton @weihanglo