Skip to content

Fix miniz_oxide types showing up in std docs #94122

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

Merged
merged 1 commit into from
Feb 20, 2022

Conversation

GuillaumeGomez
Copy link
Member

Fixes #90526.

Thanks to @camelid, I rediscovered doc(masked), allowing us to prevent miniz_oxide type to show up in std docs.

r? @notriddle

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Feb 18, 2022
@GuillaumeGomez GuillaumeGomez added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Feb 18, 2022
@GuillaumeGomez GuillaumeGomez changed the title Fix miniz_oxide types showing up in std Fix miniz_oxide types showing up in std docs Feb 18, 2022
@notriddle
Copy link
Contributor

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Feb 18, 2022

📌 Commit b78123c has been approved by notriddle

@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 Feb 18, 2022
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 19, 2022
…otriddle

Fix miniz_oxide types showing up in std docs

Fixes rust-lang#90526.

Thanks to `@camelid,` I rediscovered `doc(masked)`, allowing us to prevent `miniz_oxide` type to show up in std docs.

r? `@notriddle`
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 19, 2022
…otriddle

Fix miniz_oxide types showing up in std docs

Fixes rust-lang#90526.

Thanks to ``@camelid,`` I rediscovered `doc(masked)`, allowing us to prevent `miniz_oxide` type to show up in std docs.

r? ``@notriddle``
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 19, 2022
…otriddle

Fix miniz_oxide types showing up in std docs

Fixes rust-lang#90526.

Thanks to ```@camelid,``` I rediscovered `doc(masked)`, allowing us to prevent `miniz_oxide` type to show up in std docs.

r? ```@notriddle```
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 19, 2022
…otriddle

Fix miniz_oxide types showing up in std docs

Fixes rust-lang#90526.

Thanks to ````@camelid,```` I rediscovered `doc(masked)`, allowing us to prevent `miniz_oxide` type to show up in std docs.

r? ````@notriddle````
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 19, 2022
…otriddle

Fix miniz_oxide types showing up in std docs

Fixes rust-lang#90526.

Thanks to `````@camelid,````` I rediscovered `doc(masked)`, allowing us to prevent `miniz_oxide` type to show up in std docs.

r? `````@notriddle`````
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 19, 2022
…otriddle

Fix miniz_oxide types showing up in std docs

Fixes rust-lang#90526.

Thanks to ``````@camelid,`````` I rediscovered `doc(masked)`, allowing us to prevent `miniz_oxide` type to show up in std docs.

r? ``````@notriddle``````
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 20, 2022
…askrgr

Rollup of 14 pull requests

Successful merges:

 - rust-lang#93580 (Stabilize pin_static_ref.)
 - rust-lang#93639 (Release notes for 1.59)
 - rust-lang#93686 (core: Implement ASCII trim functions on byte slices)
 - rust-lang#94002 (rustdoc: Avoid duplicating macros in sidebar)
 - rust-lang#94019 (removing architecture requirements for RustyHermit)
 - rust-lang#94023 (adapt static-nobundle test to use llvm-nm)
 - rust-lang#94091 (Fix rustdoc const computed value)
 - rust-lang#94093 (Fix pretty printing of enums without variants)
 - rust-lang#94097 (Add module-level docs for `rustc_middle::query`)
 - rust-lang#94112 (Optimize char_try_from_u32)
 - rust-lang#94113 (document rustc_middle::mir::Field)
 - rust-lang#94122 (Fix miniz_oxide types showing up in std docs)
 - rust-lang#94142 (rustc_typeck: adopt let else in more places)
 - rust-lang#94146 (Adopt let else in more places)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit a69aaf4 into rust-lang:master Feb 20, 2022
@rustbot rustbot added this to the 1.61.0 milestone Feb 20, 2022
@GuillaumeGomez GuillaumeGomez deleted the miniz-oxide-std branch February 20, 2022 12:20
@GuillaumeGomez
Copy link
Member Author

Should we backport this to beta?

@GuillaumeGomez GuillaumeGomez added the beta-nominated Nominated for backporting to the compiler in the beta channel. label Feb 20, 2022
@camelid
Copy link
Member

camelid commented Feb 20, 2022

This isn't a recent regression AFAIK, and it's a pretty low-priority issue, so I don't see why it should be backported.

@GuillaumeGomez
Copy link
Member Author

Mostly for users comfort. If unneeded, we can just remove the label.

@camelid
Copy link
Member

camelid commented Feb 20, 2022

I won't block a backport, but I think it's best to let this ride the trains normally.

@ivmarkov
Copy link
Contributor

@GuillaumeGomez Sorry to ping, but ^^^.

@GuillaumeGomez
Copy link
Member Author

GuillaumeGomez commented Feb 21, 2022

It seems like the rustdoc team has spoken so I'll remove the tag. :)

@GuillaumeGomez GuillaumeGomez removed the beta-nominated Nominated for backporting to the compiler in the beta channel. label Feb 21, 2022
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 21, 2022
…Amanieu

Correctly handle miniz_oxide extern crate declaration

Fixes rust-lang#94219.

Follow-up of rust-lang#94122.

The `miniz_oxide` dependency is optional and therefore should allow be "imported" when it makes sense.

r? `@ivmarkov`
# for free to join this conversation on GitHub. Already have an account? # to comment
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
Development

Successfully merging this pull request may close these issues.

Standard library documentation documents trait implementations for the miniz_oxide crate
7 participants