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

Rustdoc doesn't show repr for a struct re-exported from another package #110698

Closed
nicholasbishop opened this issue Apr 22, 2023 · 3 comments · Fixed by #110901
Closed

Rustdoc doesn't show repr for a struct re-exported from another package #110698

nicholasbishop opened this issue Apr 22, 2023 · 3 comments · Fixed by #110901
Assignees
Labels
A-ABI Area: Concerning the application binary interface (ABI) A-cross-crate-reexports Area: Documentation that has been re-exported from a different crate C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@nicholasbishop
Copy link
Contributor

If you define a struct with an explicit repr(...) in one package, then pub use it in another package, rustdoc doesn't show the repr on the re-exported one.

Minimal repo showing this problem: https://github.com/nicholasbishop/pub-use-repr-doc-bug

In pkg1 you get:
image

But in pkg2 you get:
image

Meta

rustc --version --verbose:

rustc 1.69.0 (84c898d65 2023-04-16)
binary: rustc
commit-hash: 84c898d65adf2f39a5a98507f1fe0ce10a2b8dbc
commit-date: 2023-04-16
host: x86_64-unknown-linux-gnu
release: 1.69.0
LLVM version: 15.0.7

Also tested on nightly, same result:

rustc 1.71.0-nightly (8bdcc62cb 2023-04-20)
binary: rustc
commit-hash: 8bdcc62cb0362869f0e7b43a6ae4f96b953d3cbc
commit-date: 2023-04-20
host: x86_64-unknown-linux-gnu
release: 1.71.0-nightly
LLVM version: 16.0.2
@nicholasbishop nicholasbishop added the C-bug Category: This is a bug. label Apr 22, 2023
@Ezrashaw
Copy link
Contributor

I suspect that this kind of metadata isn't saved to disk and therefore rustdoc has no idea about the existence of the attribute on foreign types.

@jyn514 jyn514 added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-cross-crate-reexports Area: Documentation that has been re-exported from a different crate A-ABI Area: Concerning the application binary interface (ABI) labels Apr 27, 2023
@GuillaumeGomez
Copy link
Member

That's a regression actually since it was there before #98450. Fixing it.

@nicholasbishop
Copy link
Contributor Author

Great, thanks for the quick fix!

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Apr 28, 2023
…c, r=notriddle

rustdoc: Fix missing `repr` attribute in doc(inline) on foreign items

Fixes rust-lang#110698.

r? `@notriddle`
@bors bors closed this as completed in f495605 Apr 28, 2023
bindsdev pushed a commit to bindsdev/rust that referenced this issue Apr 29, 2023
RalfJung pushed a commit to RalfJung/miri that referenced this issue Apr 30, 2023
rustdoc: Fix missing `repr` attribute in doc(inline) on foreign items

Fixes rust-lang/rust#110698.

r? `@notriddle`
RalfJung pushed a commit to RalfJung/rust-analyzer that referenced this issue Apr 20, 2024
rustdoc: Fix missing `repr` attribute in doc(inline) on foreign items

Fixes rust-lang/rust#110698.

r? `@notriddle`
RalfJung pushed a commit to RalfJung/rust-analyzer that referenced this issue Apr 27, 2024
rustdoc: Fix missing `repr` attribute in doc(inline) on foreign items

Fixes rust-lang/rust#110698.

r? `@notriddle`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ABI Area: Concerning the application binary interface (ABI) A-cross-crate-reexports Area: Documentation that has been re-exported from a different crate 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
Development

Successfully merging a pull request may close this issue.

4 participants