Repository navigation
rustdoc: Bad handling of proc_macro's re-exported via use_extern_macros #49553
Description
If you define a proc-macro in one crate, then re-export it from another crate via the use_extern_macros feature the resulting documentation does not link to the macro correctly, and the tooltip has some weird details displayed in it:
link: ../proc_macro_re_export_proc_macro/macro.%7B%7BGlobalMetaData::Krate%7D%7D.html
Reacted by Peter Huene
Reacted by Chris Wong
Activity
QuietMisdreavus commentedon Aug 23, 2018
Still broken, looks like. Seems we'll need to properly document proc-macros, and handle their re-export, now.
Something that strikes me as odd is that the original crate shows the proc-macro as a function, and it's only when it's re-exported is it seen as a macro:
I think we'll need to handle the
#[proc_macro_attribute](and other proc-macro declaration attributes) when displaying these items. Then we'll need to see what happens when we get these as re-exports. I'm not too surprised that it still appears as a re-export, but i am curious what is causing it to mess up the link like that.QuietMisdreavus commentedon Sep 24, 2018
Update: It looks like the odd curly-brace segment of the link is gone, but the links are still broken because rustdoc is still treating proc-macros as functions in their source crate. Not sure what fixed that, but it means one less thing to figure out when fixing this for real.
QuietMisdreavus commentedon Sep 25, 2018
I've opened #54577 to make rustdoc properly document proc-macros, but there's a wrinkle that means their re-export is still a little awkward (though it's better than before). I wrote more about it in that PR.
Rollup merge of rust-lang#54577 - QuietMisdreavus:docs-for-procs, r=G…
3 remaining items
Fix the circular crate dependency by fooling rustdoc
Fix the circular crate dependency by fooling rustdoc
Rollup merge of rust-lang#62855 - Aaron1011:feature/rustdoc-reexport-…
Rollup merge of rust-lang#62855 - Aaron1011:feature/rustdoc-reexport-…