Fix rendering of reexported macros 2.0 and fix visibility of reexported items #86841

GuillaumeGomez · 2021-07-03T13:13:33Z

So, this PR grew a bit out of focus, it does the following things:

Fixes rustdoc: Re-exported macros 2.0 are rendered as macro_rules! #86276.
Fixes visibility display for reexported items: it now takes the visibility of the "use" statement rather than the visibility of the reexported item itself).
Fixes the display of reexported items if "--document-private-items" option is used. Before, they were simply skipped.
Fixes inconsistency on typedef items: they didn't display their visibility contrary to other items.

I added tests to check everything listed above.

cc @camelid @ollie27 (in case one of you want to review?)

src/librustdoc/clean/inline.rs

jyn514 · 2021-07-03T13:17:28Z

Both this and #86282 basically rewrite the macro rendering, I would rather not review both at once. I plan to review the other first since it's a more serious bug.

GuillaumeGomez · 2021-07-03T18:00:44Z

Both this and #86282 basically rewrite the macro rendering, I would rather not review both at once. I plan to review the other first since it's a more serious bug.

It's fine, let's wait until #86282 is merged! I'll mark the PR as blocked for the time being and give a try to improve the code by removing the duplication.

GuillaumeGomez · 2021-07-03T18:42:41Z

I unified it into a function in the end. :)

GuillaumeGomez · 2021-07-05T09:01:24Z

Rebased on #86282.

jyn514

LGTM with the nit about display_macro_source fixed

src/librustdoc/clean/utils.rs

jyn514 · 2021-07-05T16:15:48Z

src/librustdoc/clean/mod.rs

+                Visibility::Restricted(krate)
+            }
+            ast::VisibilityKind::Restricted { id, .. } => {
+                let did = cx.enter_resolver(|r| r.local_def_id(id)).to_def_id();


It's unfortunate that this has to call into the resolver :/ I'm hoping to get rid of it at some point: #83761. But we already call load_macro_untracked above, so hopefully fixing that will allow removing this impl at the same time.

jyn514 · 2021-07-05T16:17:18Z

Oh I forgot - can you add a test for pub(crate) and pub(self) macros? Right now impl Clean for ast::Visibility isn't tested at all.

…Gomez Remove `impl Clean for {Ident, Symbol}` These were only used once, in a place where it was trivial to replace. Also, it's unclear what 'clean' would mean for these, so it seems better to be explicit. Found while reviewing rust-lang#86841, which makes the same change to `build_macro`, so the two will conflict. r? `@GuillaumeGomez`

GuillaumeGomez · 2021-07-05T18:32:41Z

Adding the requested tests then.

src/test/rustdoc/auxiliary/macro-2-reexport.rs

GuillaumeGomez · 2021-07-06T13:25:36Z

I updated the PR and the first comment as well to explain what I did here. I don't know why I expected less things to be broken around reexports... Anyway, that should clean things up quite a lot.

src/librustdoc/clean/mod.rs

src/test/rustdoc/reexports-priv.rs

GuillaumeGomez · 2021-07-07T11:48:33Z

@Stupremee Fixed the issue you spotted and added a test to prevent a regression.

GuillaumeGomez · 2021-07-12T11:11:00Z

@bors: r=Stupremee

bors · 2021-07-12T11:11:01Z

📌 Commit 74d71c2 has been approved by Stupremee

bors · 2021-07-12T11:53:00Z

⌛ Testing commit 74d71c2 with merge 3a24abd...

bors · 2021-07-12T14:33:44Z

☀️ Test successful - checks-actions
Approved by: Stupremee
Pushing 3a24abd to master...

GuillaumeGomez added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jul 3, 2021

rust-highfive assigned jyn514 Jul 3, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 3, 2021

GuillaumeGomez force-pushed the reexported-macro-2-render branch from e2b3631 to b75fa0d Compare July 3, 2021 13:13

jyn514 changed the title ~~Reexported macro 2 render~~ Rustdoc: Fix rendering of reexported macros 2.0 Jul 3, 2021

GuillaumeGomez commented Jul 3, 2021

View reviewed changes

src/librustdoc/clean/inline.rs Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

jyn514 added S-blocked Status: Blocked on something else such as an RFC or other implementation work. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 3, 2021

GuillaumeGomez force-pushed the reexported-macro-2-render branch from b75fa0d to 7e32bee Compare July 3, 2021 18:41

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the reexported-macro-2-render branch from 7e32bee to ea5c680 Compare July 5, 2021 09:00

GuillaumeGomez added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-blocked Status: Blocked on something else such as an RFC or other implementation work. labels Jul 5, 2021

jyn514 mentioned this pull request Jul 5, 2021

Remove impl Clean for {Ident, Symbol} #86886

Merged

jyn514 approved these changes Jul 5, 2021

View reviewed changes

camelid reviewed Jul 5, 2021

View reviewed changes

src/test/rustdoc/auxiliary/macro-2-reexport.rs Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the reexported-macro-2-render branch from ea5c680 to ba6d930 Compare July 6, 2021 08:36

GuillaumeGomez force-pushed the reexported-macro-2-render branch from 9e824b1 to 0d3d3fc Compare July 6, 2021 13:20

GuillaumeGomez changed the title ~~Rustdoc: Fix rendering of reexported macros 2.0~~ Fix rendering of reexported macros 2.0 and fix visibility of reexported items Jul 6, 2021

GuillaumeGomez force-pushed the reexported-macro-2-render branch from 0d3d3fc to 3137bd1 Compare July 6, 2021 13:23

Stupremee approved these changes Jul 7, 2021

View reviewed changes

src/librustdoc/clean/mod.rs Outdated Show resolved Hide resolved

src/test/rustdoc/reexports-priv.rs Show resolved Hide resolved

GuillaumeGomez added 7 commits July 7, 2021 11:30

Fix rendering of reexported macros 2.0

d1ad40e

Add test for reexported macros 2.0 rendering

c70250d

Unify macro source display

84f259e

Fix reexports visibility

e948e8d

Fix inconsistency on visibility display for typedefs

cc09326

Add tests for reexports (both public and private)

e7bc2a0

Only show restricted pub use

74d71c2

GuillaumeGomez force-pushed the reexported-macro-2-render branch from 3137bd1 to 74d71c2 Compare July 7, 2021 11:47

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jul 12, 2021

bors added the merged-by-bors This PR was explicitly merged by bors. label Jul 12, 2021

bors merged commit 3a24abd into rust-lang:master Jul 12, 2021

rustbot added this to the 1.55.0 milestone Jul 12, 2021

GuillaumeGomez deleted the reexported-macro-2-render branch July 12, 2021 14:39

This was referenced Jul 12, 2021

Ignore derived Clone and Debug implementations during dead code analysis #85200

Merged

rustdoc: Cleanup ExternalCrate #86889

Merged

jyn514 mentioned this pull request Nov 8, 2021

Use computed visibility in rustdoc #88447

Merged

Fix rendering of reexported macros 2.0 and fix visibility of reexported items #86841

Fix rendering of reexported macros 2.0 and fix visibility of reexported items #86841

Uh oh!

Conversation

GuillaumeGomez commented Jul 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

jyn514 commented Jul 3, 2021

Uh oh!

This comment has been minimized.

GuillaumeGomez commented Jul 3, 2021

Uh oh!

GuillaumeGomez commented Jul 3, 2021

Uh oh!

This comment has been minimized.

GuillaumeGomez commented Jul 5, 2021

Uh oh!

jyn514 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jyn514 Jul 5, 2021

Choose a reason for hiding this comment

Uh oh!

jyn514 commented Jul 5, 2021

Uh oh!

GuillaumeGomez commented Jul 5, 2021

Uh oh!

Uh oh!

This comment has been minimized.

GuillaumeGomez commented Jul 6, 2021

Uh oh!

Uh oh!

Uh oh!

GuillaumeGomez commented Jul 7, 2021

Uh oh!

GuillaumeGomez commented Jul 12, 2021

Uh oh!

bors commented Jul 12, 2021

Uh oh!

bors commented Jul 12, 2021

Uh oh!

bors commented Jul 12, 2021

Uh oh!

Uh oh!

GuillaumeGomez commented Jul 3, 2021 •

edited

Loading