Skip to content

Turn off -Zrustdoc-scrape-examples for proc macro crates #1965

New issue

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

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

Already on GitHub? # to your account

Closed
dtolnay opened this issue Dec 18, 2022 · 1 comment
Closed

Turn off -Zrustdoc-scrape-examples for proc macro crates #1965

dtolnay opened this issue Dec 18, 2022 · 1 comment

Comments

@dtolnay
Copy link
Member

dtolnay commented Dec 18, 2022

Crate name

automod

Build failure link

https://docs.rs/crate/automod/1.0.5/builds/703499

Additional details

It would be extremely unusual for a proc macro crate's implementation to call its own macros. Until rust-lang/cargo#11496 is fixed, or possibly even beyond that point, consider not passing -Zrustdoc-scrape-examples when the crate being documented is a proc macro.

@willcrichton
Copy link
Contributor

This issue will be fixed in rust-lang/cargo#11497.

I would prefer to keep this flag on for all crates rather than special-casing it, since the goal is eventually to have it be a default code pathway within Rustdoc, and it should be robust enough to handle these cases.

@dtolnay dtolnay closed this as completed Dec 18, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants