Skip to content

Check implementing type for #[doc(hidden)] #89987

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

Jump to bottom
Merged
merged 1 commit into from
Oct 18, 2021
Merged

Check implementing type for #[doc(hidden)] #89987

merged 1 commit into from
Oct 18, 2021

Conversation

pierwill
Copy link
Member

Closes #85526.

@rust-highfive
Copy link
Contributor

r? @jackh726

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 17, 2021
@pierwill pierwill force-pushed the fix-85526-docs-hidden-assoc branch 3 times, most recently from a599b83 to bc5ed6e Compare October 17, 2021 19:57
@camelid
Copy link
Member

camelid commented Oct 17, 2021

r? rust-lang/rustdoc

@rust-highfive rust-highfive assigned ollie27 and unassigned jackh726 Oct 17, 2021
@camelid
Copy link
Member

camelid commented Oct 17, 2021

r? @GuillaumeGomez

@camelid camelid added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Oct 17, 2021
@GuillaumeGomez
Copy link
Member

Apart from the nit, looks good to me, thanks for the improvement/fix! Feel free to r+ if you think the suggestion I made isn't worth it.

@pierwill
Copy link
Member Author

@GuillaumeGomez Is it alright if I like the original code a little better? 😇 (Also, I don't have r+ privileges 😇 😇 .)

@GuillaumeGomez
Copy link
Member

It's perfectly fine. :)

Then let's go with this this!

@bors: r+ squash

@bors
Copy link
Collaborator

bors commented Oct 17, 2021

📌 Commit 8f2551d0dbdd066914ece68d312038a957d6eeea has been approved by GuillaumeGomez

@bors 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-review Status: Awaiting review from the assignee but also interested parties. labels Oct 17, 2021
@camelid
Copy link
Member

camelid commented Oct 17, 2021

@bors r- squash-

bors squash doesn't work correctly, please don't use it :)

@pierwill Can you squash your commits manually please?

@bors bors 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-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Oct 17, 2021
@pierwill pierwill force-pushed the fix-85526-docs-hidden-assoc branch from 8f2551d to d39a1be Compare October 17, 2021 21:37
@camelid
Copy link
Member

camelid commented Oct 17, 2021

bors squash doesn't work correctly, please don't use it :)

See rust-lang/homu#136 and rust-lang/homu#158 for more information.

@pierwill
Copy link
Member Author

Done.

@camelid
Copy link
Member

camelid commented Oct 17, 2021

Thanks!

@bors r=@GuillaumeGomez rollup

@bors
Copy link
Collaborator

bors commented Oct 17, 2021

📌 Commit d39a1be has been approved by GuillaumeGomez

@bors bors removed the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Oct 17, 2021
@bors bors added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Oct 17, 2021
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Oct 17, 2021
@matthiaskrgr
Rollup merge of rust-lang#89987 - pierwill:fix-85526-docs-hidden-asso…
dabfe6c 
…c, r=GuillaumeGomez

Check implementing type for `#[doc(hidden)]`

Closes rust-lang#85526.
@matthiaskrgr matthiaskrgr mentioned this pull request Oct 17, 2021
Closed
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Oct 17, 2021
@matthiaskrgr
Rollup merge of rust-lang#89987 - pierwill:fix-85526-docs-hidden-asso…
4e4cccb 
…c, r=GuillaumeGomez

Check implementing type for `#[doc(hidden)]`

Closes rust-lang#85526.
This was referenced Oct 17, 2021
Closed
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 18, 2021
@bors
Auto merge of rust-lang#90000 - matthiaskrgr:rollup-vj7wwur, r=matthi…
5dab47d 
…askrgr

Rollup of 8 pull requests

Successful merges:

 - rust-lang#89950 (bootstrap: tweak verbosity settings)
 - rust-lang#89965 (Fix ICE with `let...else` and `ref mut`)
 - rust-lang#89974 (Nicer error message if the user attempts to do let...else if)
 - rust-lang#89987 (Check implementing type for `#[doc(hidden)]`)
 - rust-lang#89989 (rustdoc: Add static size assertion for `clean::Type`)
 - rust-lang#89990 (rustc_span: `Ident::invalid` -> `Ident::empty`)
 - rust-lang#89993 (Remove dead code from `compiletest::json`)
 - rust-lang#89996 (Bump backtrace)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@jyn514
Copy link
Member

jyn514 commented Oct 18, 2021

@camelid is there a reason you assigned Guillaume instead of a T-compiler reviewer? That seems pretty solidly in their wheelhouse to me ... missing_docs is not a rustdoc lint.

@GuillaumeGomez
Copy link
Member

I'm the one who implemented it, so I guess it's the reason? ;)

@bors bors merged commit cd72393 into rust-lang:master Oct 18, 2021
@rustbot rustbot added this to the 1.58.0 milestone Oct 18, 2021
@pierwill pierwill deleted the fix-85526-docs-hidden-assoc branch October 18, 2021 15:59
@camelid
Copy link
Member

camelid commented Oct 18, 2021 •
edited
Loading

@camelid is there a reason you assigned Guillaume instead of a T-compiler reviewer? That seems pretty solidly in their wheelhouse to me ... missing_docs is not a rustdoc lint.

My understanding was that we (T-rustdoc) are mainly the ones who maintain it, just like with the checks in rustc_passes that detect incorrect use of #[doc]. And #[doc(hidden)] is a rustdoc feature.

# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@GuillaumeGomez GuillaumeGomez GuillaumeGomez left review comments

Assignees

@GuillaumeGomez GuillaumeGomez

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.58.0
Development

Successfully merging this pull request may close these issues.

missing_docs lint does not take into account the implementing type being #[doc(hidden)]
9 participants
@pierwill @rust-highfive @camelid @GuillaumeGomez @bors @jyn514 @ollie27 @jackh726 @rustbot