Skip to content

Rustdoc does not combine documentation in re-exports of extern functions #135092

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
Open
cuttestkittensrule opened this issue Jan 4, 2025 · 0 comments · May be fixed by #141831
Open

Rustdoc does not combine documentation in re-exports of extern functions #135092

cuttestkittensrule opened this issue Jan 4, 2025 · 0 comments · May be fixed by #141831
Assignees
@lolbinarycat
Labels
A-local-reexports Area: Documentation that has been locally re-exported (i.e., non-cross-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

@cuttestkittensrule
Copy link

With the code

mod native {
    extern "C" {
        /// bar.
        pub fn bar();
    }
}

/// foo
pub use native::bar;

I expected to have the documentation in the private module and the re-export to be combined

Instead, only the documentation in the private module in shown

Image

Meta

rustdoc --version --verbose:

rustdoc 1.86.0-nightly (3f43b1a63 2025-01-03)
binary: rustdoc
commit-hash: 3f43b1a636738f41c48df073c5bcb97a97bf8459
commit-date: 2025-01-03
host: x86_64-unknown-linux-gnu
release: 1.86.0-nightly
LLVM version: 19.1.6
@cuttestkittensrule cuttestkittensrule added the C-bug Category: This is a bug. label Jan 4, 2025
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Jan 4, 2025
@jieyouxu jieyouxu added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Jan 6, 2025
@lolbinarycat lolbinarycat added the A-local-reexports Area: Documentation that has been locally re-exported (i.e., non-cross-crate) label May 29, 2025
@lolbinarycat lolbinarycat self-assigned this May 29, 2025
@GuillaumeGomez GuillaumeGomez added C-bug Category: This is a bug. and removed C-bug Category: This is a bug. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels May 29, 2025
lolbinarycat added a commit to lolbinarycat/rust that referenced this issue May 31, 2025
@lolbinarycat
rustdoc: add regression test for rust-lang#135092
1610dc1
@lolbinarycat lolbinarycat linked a pull request May 31, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lolbinarycat lolbinarycat

Labels
A-local-reexports Area: Documentation that has been locally re-exported (i.e., non-cross-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
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

rustdoc: fix attrs of locally reexported foreign items lolbinarycat/rust
5 participants
@GuillaumeGomez @lolbinarycat @jieyouxu @rustbot @cuttestkittensrule