Skip to content

Do not display hidden types, fixes issue 23912 - #46359

Merged
bors merged 1 commit into
rust-lang:masterfrom
GuillaumeGomez:remove-dead-linkage
Dec 20, 2017
Merged

Do not display hidden types, fixes issue 23912#46359
bors merged 1 commit into
rust-lang:masterfrom
GuillaumeGomez:remove-dead-linkage

Conversation

@GuillaumeGomez

@GuillaumeGomezGuillaumeGomez commented Nov 29, 2017

Copy link
Copy Markdown
Member

Fixes#23912.

r? @QuietMisdreavus

(It's the one I was talking about a few days ago, just close it if it's useless.)

@kennytmkennytm added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 29, 2017
@QuietMisdreavus

QuietMisdreavus commented Nov 29, 2017

Copy link
Copy Markdown
Contributor

It looks like would just hide the [src] link? The rest of the impl will still be visible if the item had no visibility set. And the impl will not even get there in the first place if the for_ type is in a #[doc(masked)] crate anyway. The issue was actually fixed by #44026, and i'll close it out. It seems the issue i actually referenced/closed in that PR was a duplicate of that one. >_>

On the other hand, the test you have here is useful, but i think it would be better if the trait that was #[doc(hidden)] were public as well, since it would be removed from docs anyway for being a private item.

ollie27
ollie27 reviewed Nov 29, 2017
View reviewed changes

@ollie27ollie27 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to be very careful when writing @!has tests because typos mean the test passes without testing anything 😉.

Comment threadsrc/test/rustdoc/hidden-trait-struct-impls.rs Outdated

@ollie27ollie27Nov 29, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

struct.Bar.html -> trait.Bam.html

iimplementors-list -> implementors-list

Comment threadsrc/test/rustdoc/hidden-trait-struct-impls.rs Outdated

@ollie27ollie27Nov 29, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

impl-Bar -> impl-Foo

@GuillaumeGomez

GuillaumeGomez commented Nov 30, 2017

Copy link
Copy Markdown
MemberAuthor

@ollie27: Arf, you're right! Thanks!

@kennytmkennytm added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 6, 2017
@kennytm

kennytm commented Dec 6, 2017

Copy link
Copy Markdown
Member

@GuillaumeGomez@QuietMisdreavus Is this PR still needed? #23912 has been closed by #44026.

@QuietMisdreavus

QuietMisdreavus commented Dec 6, 2017

Copy link
Copy Markdown
Contributor

@kennytm I want it for the test test it adds. If @GuillaumeGomez can take out the change in render.rs and address the review comments on the test, i'll add it.

@carols10cents

carols10cents commented Dec 12, 2017

Copy link
Copy Markdown
Member

Friendly ping to keep this on your radar @GuillaumeGomez!

@GuillaumeGomez

GuillaumeGomez commented Dec 13, 2017

Copy link
Copy Markdown
MemberAuthor

Going back on it this week-end.

@GuillaumeGomez

GuillaumeGomez commented Dec 17, 2017

Copy link
Copy Markdown
MemberAuthor

Updated.

@kennytmkennytm added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Dec 17, 2017
QuietMisdreavus
QuietMisdreavus reviewed Dec 18, 2017
View reviewed changes
Comment threadsrc/test/rustdoc/hidden-trait-struct-impls.rs Outdated

@QuietMisdreavusQuietMisdreavusDec 18, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tagging a private item with #[doc(hidden)] has no effect when you're not changing which passes are run. Can you make this pub trait Foo instead?

@GuillaumeGomez

GuillaumeGomez commented Dec 18, 2017

Copy link
Copy Markdown
MemberAuthor

Updated.

@QuietMisdreavus

QuietMisdreavus commented Dec 18, 2017

Copy link
Copy Markdown
Contributor

r=me pending travis

This is... kinda unrelated to #23912 now, but as i said, the test is still useful.

@QuietMisdreavus

QuietMisdreavus commented Dec 19, 2017

Copy link
Copy Markdown
Contributor

@bors r+ rollup

@bors

bors commented Dec 19, 2017

Copy link
Copy Markdown
Collaborator

📌 Commit 03530ee has been approved by QuietMisdreavus

@kennytmkennytm 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-review Status: Awaiting review from the assignee but also interested parties. labels Dec 19, 2017
kennytm added a commit to kennytm/rust that referenced this pull request Dec 20, 2017
@kennytm
Rollup merge ofrust-lang#46359- GuillaumeGomez:remove-dead-linkage,…
8de8196
… r=QuietMisdreavus
Do not display hidden types, fixes issue 23912
Fixesrust-lang#23912.
r? @QuietMisdreavus
(It's the one I was talking about a few days ago, just close it if it's useless.)
@kennytmkennytm mentioned this pull request Dec 20, 2017
Merged
bors added a commit that referenced this pull request Dec 20, 2017
@bors
Auto merge of#46874- kennytm:rollup, r=kennytm
81622c6
Rollup of 14 pull requests
- Successful merges: #46359, #46517, #46671, #46751, #46760, #46787, #46794, #46828, #46831, #46835, #46851, #46852, #46856, #46870
- Failed merges:
@bors
bors merged commit 03530ee into rust-lang:masterDec 20, 2017
@GuillaumeGomez
GuillaumeGomez deleted the remove-dead-linkage branch December 21, 2017 09:07
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers
@QuietMisdreavusQuietMisdreavusQuietMisdreavus left review comments
@ollie27ollie27ollie27 left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@QuietMisdreavusQuietMisdreavus

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

rustdoc links to private structs, causing 404s

6 participants

@GuillaumeGomez@QuietMisdreavus@kennytm@carols10cents@bors@ollie27