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

rustdoc: Macros re-exported via use_extern_macro appear as a re-export #49554

Closed
Nemo157 opened this issue Apr 1, 2018 · 3 comments
Closed
Labels
A-macros-1.2 Area: Declarative macros 1.2 A-macros-2.0 Area: Declarative macros 2.0 (#39412) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@Nemo157
Copy link
Member

Nemo157 commented Apr 1, 2018

Most other items re-exported from an extern crate appear as if they're defined directly in the place they're re-exported from. For some reason macros are not currently treated the same way, they show up under the "Re-exports" heading and don't have their documentation summary shown. For futures this would be very useful for documenting the async/await macros in the facade.

Example (code here):

screen shot 2018-04-01 at 11 49 53 am

@pietroalbini pietroalbini added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-enhancement Category: An issue proposing an enhancement or a PR with one. A-macros-2.0 Area: Declarative macros 2.0 (#39412) T-dev-tools-rustdoc labels Apr 12, 2018
@alexcrichton alexcrichton added the A-macros-1.2 Area: Declarative macros 1.2 label May 22, 2018
@QuietMisdreavus
Copy link
Member

I think this should have been fixed with #51011 (and later #51611). However, now the proc-macro re-export may not appear? IIRC, rustdoc doesn't even try to document proc-macros. Can you try running docs for your demo crate with the latest nightly?

@Nemo157
Copy link
Member Author

Nemo157 commented Aug 23, 2018

I've regenerated and pushed the docs to the link in the OP. The normal macro is fixed, but the proc-macro re-export has stayed the same (including #49553 messing up the link).

@QuietMisdreavus
Copy link
Member

Aha! Thanks so much for making a test case like this, it'll really help for testing it. I'll close this in favor of #49553, since that seems to describe the outstanding issue better.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-macros-1.2 Area: Declarative macros 1.2 A-macros-2.0 Area: Declarative macros 2.0 (#39412) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

4 participants