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.

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

rustc docs: Re-exported types' implementations are lost #88758

Open
camelid opened this issue Sep 8, 2021 · 3 comments
Open

rustc docs: Re-exported types' implementations are lost #88758

camelid opened this issue Sep 8, 2021 · 3 comments
Labels
A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself A-cross-crate-reexports Area: Documentation that has been re-exported from a different crate A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. P-medium Medium priority regression-from-stable-to-stable Performance or correctness regression from one stable version to another. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@camelid
Copy link
Member

camelid commented Sep 8, 2021

For example, ObligationCause is defined in rustc_middle, and its docs look like this:

image


But it is also re-exported by rustc_trait_selection, where its inherent and trait implementations don't appear in the docs:

image


This regressed in 1.47.0 (look at /1.46.0/nightly-rustc vs /1.47.0/nightly-rustc to compare). That is also the release when the rustc_private warning stopped showing up in the docs, so I wonder if the two changes are connected somehow. Furthermore, I have never witnessed this bug outside of the rustc docs, which makes me even more suspicious that something about rustc_private or rustbuild is causing this.

@camelid camelid added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. regression-from-stable-to-stable Performance or correctness regression from one stable version to another. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. A-cross-crate-reexports Area: Documentation that has been re-exported from a different crate labels Sep 8, 2021
@rustbot rustbot added the I-prioritize Issue: Indicates that prioritization has been requested for this issue. label Sep 8, 2021
@camelid
Copy link
Member Author

camelid commented Sep 8, 2021

cc @rust-lang/rustdoc

@camelid camelid added the A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself label Sep 8, 2021
@apiraino
Copy link
Contributor

Assigning priority as discussed in the Zulip thread of the Prioritization Working Group.

@rustbot label -I-prioritize +P-medium

@rustbot rustbot added P-medium Medium priority and removed I-prioritize Issue: Indicates that prioritization has been requested for this issue. labels Sep 15, 2021
@jyn514 jyn514 removed the T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) label Nov 9, 2021
@fmease
Copy link
Member

fmease commented Feb 15, 2024

Triage: Still an issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself A-cross-crate-reexports Area: Documentation that has been re-exported from a different crate A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. P-medium Medium priority regression-from-stable-to-stable Performance or correctness regression from one stable version to another. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

5 participants