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

Scrape examples config in rustdoc book is wrong #110711

Closed
robagar opened this issue Apr 22, 2023 · 5 comments · Fixed by #110905
Closed

Scrape examples config in rustdoc book is wrong #110711

robagar opened this issue Apr 22, 2023 · 5 comments · Fixed by #110905
Assignees
@john-h-k
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@robagar
Copy link

robagar commented Apr 22, 2023 •
edited by rustbot
Loading

Crate name

Tello-edu

Build failure link

https://docs.rs/crate/tello-edu/0.5.2/builds/798419

Additional details

The rustdoc book says use

[package.metadata.docs.rs]
cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples=examples"]

...but my build failed with error

[INFO] [stderr] error: flag -Zrustdoc-scrape-examples does not take a value, found: `examples`
@syphar
Copy link
Member

syphar commented Apr 23, 2023

cc @willcrichton @jyn514 could you provide some input here?

Thanks!

@jyn514
Copy link
Member

jyn514 commented Apr 23, 2023

The rustdoc book documents rustdoc flags. You are passing this flag to cargo. I don't remember how to configure cargo for this argument off the top of my head, but you should look in the cargo book for how.

@jyn514
Copy link
Member

jyn514 commented Apr 23, 2023

Oh wait, apparently the rustdoc book directly documents using this with docs.rs?? it's probably just outdated then - I'll transfer this to rust-lang/rust.

@jyn514 jyn514 transferred this issue from rust-lang/docs.rs Apr 23, 2023
@jyn514 jyn514 added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. labels Apr 23, 2023
@robagar
Copy link
Author

robagar commented Apr 23, 2023

Btw it works fine after taking out the "=examples"

@jyn514 jyn514 added the E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. label Apr 23, 2023
@john-h-k john-h-k mentioned this issue Apr 27, 2023
Merged
@john-h-k
Copy link
Contributor

@rustbot claim

@bors bors closed this as completed in 790912a Apr 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@john-h-k john-h-k

Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Remove invalid value from scraped-examples.md john-h-k/rust
4 participants
@syphar @robagar @jyn514 @john-h-k