Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Standard library documentation documents trait implementations for the miniz_oxide crate #90526

Closed
FSMaxB opened this issue Nov 3, 2021 · 6 comments · Fixed by #94122
Closed

Standard library documentation documents trait implementations for the miniz_oxide crate #90526

FSMaxB opened this issue Nov 3, 2021 · 6 comments · Fixed by #94122
Labels
C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@FSMaxB
Copy link

FSMaxB commented Nov 3, 2021 •
edited
Loading

While looking at the standard library documentation of std::result::Result I found some trait implementations of From<StreamResult> documented there. These belong to the miniz_oxide crate. I do not think this trait implementation belongs in the standard library documentation.

See https://doc.rust-lang.org/stable/std/result/enum.Result.html#impl-From%3CStreamResult%3E
This is also present in the standard library documentation that rustup installs locally.

Meta

The Version string on docs.rust-lang.org is Version 1.56.1 (59eed8a2a 2021-11-01) at the time of writing.

I was told on the #docs-rs discord channel to tag @GuillaumeGomez in this issue.
@FSMaxB FSMaxB added the C-bug Category: This is a bug. label Nov 3, 2021
@GuillaumeGomez GuillaumeGomez added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Nov 3, 2021
@GuillaumeGomez
Copy link
Member

They should definitely not be displayed.

@GuillaumeGomez
Copy link
Member

After taking a look, I have to admit that I have no idea how to handle this... We could add #[doc(hidden)] on miniz_oxide implementation I guess, but do we want this?

Maybe you have an idea @camelid @notriddle ?

@notriddle
Copy link
Contributor

This seems related to #88696.

@GuillaumeGomez
Copy link
Member

Thanks for the link!

@camelid
Copy link
Member

camelid commented Feb 17, 2022

I think this is exactly what #[doc(masked)] is for, isn't it?

@GuillaumeGomez
Copy link
Member

GuillaumeGomez commented Feb 18, 2022 •
edited
Loading

It is, but the miniz-oxide crate might still want to show these impls though.

EDIT: nevermind, you're absolutely right @camelid. I confused it with doc(hidden)...

@GuillaumeGomez GuillaumeGomez mentioned this issue Feb 18, 2022
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Feb 19, 2022
@matthiaskrgr
Rollup merge of rust-lang#94122 - GuillaumeGomez:miniz-oxide-std, r=n…
1160ea2 
…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 issue Feb 19, 2022
@matthiaskrgr
Rollup merge of rust-lang#94122 - GuillaumeGomez:miniz-oxide-std, r=n…
25e3b81 
…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 issue Feb 19, 2022
@matthiaskrgr
Rollup merge of rust-lang#94122 - GuillaumeGomez:miniz-oxide-std, r=n…
72fb9d4 
…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 issue Feb 19, 2022
@matthiaskrgr
Rollup merge of rust-lang#94122 - GuillaumeGomez:miniz-oxide-std, r=n…
4108ebc 
…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 issue Feb 19, 2022
@matthiaskrgr
Rollup merge of rust-lang#94122 - GuillaumeGomez:miniz-oxide-std, r=n…
83b2ab0 
…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 issue Feb 19, 2022
@matthiaskrgr
Rollup merge of rust-lang#94122 - GuillaumeGomez:miniz-oxide-std, r=n…
ee373d2 
…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 bors closed this as completed in a69aaf4 Feb 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix miniz_oxide types showing up in std docs GuillaumeGomez/rust
4 participants
@notriddle @GuillaumeGomez @FSMaxB @camelid