Skip to content

docs generation ignoring 'no docs' for re-exported items #139910

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

Closed
jnqnfe opened this issue Apr 16, 2025 · 1 comment
Closed

docs generation ignoring 'no docs' for re-exported items #139910

jnqnfe opened this issue Apr 16, 2025 · 1 comment
Labels
A-crates Area: Crates and their interactions (like crate loading) C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jnqnfe
Copy link
Contributor

jnqnfe commented Apr 16, 2025

Location

https://doc.rust-lang.org/std/ffi/enum.c_void.html

Summary

The core::ffi::c_void type, if you look at the underlying code, has an attribute #[cfg_attr(not(doc), repr(u8))] with a comment alongside it that reads as follows:

An implementation detail we don't want to show up in rustdoc

This detail indeed does not show up on the core::ffi::c_void page, however this type is re-exported as std::ffi::c_void where this detail is shown on the page. It seems that rustdoc ignores such do-not-document attributes for re-exported items.

@jnqnfe jnqnfe added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Apr 16, 2025
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Apr 16, 2025
@jnqnfe jnqnfe changed the title docs generation ignoring 'no docs' for re-export docs generation ignoring 'no docs' for re-exported items Apr 16, 2025
@fmease fmease added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-bug Category: This is a bug. A-crates Area: Crates and their interactions (like crate loading) and removed A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Apr 16, 2025
@fmease
Copy link
Member

fmease commented Apr 16, 2025

Dupe of #114952 but the concrete issue regarding priv repr will be fixed much sooner, cc #116882

@fmease fmease closed this as completed Apr 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-crates Area: Crates and their interactions (like crate loading) 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

No branches or pull requests

3 participants