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 does not warn when linking to an item with no generated docs #81979

Open
jyn514 opened this issue Feb 11, 2021 · 0 comments
Open

rustdoc does not warn when linking to an item with no generated docs #81979

jyn514 opened this issue Feb 11, 2021 · 0 comments
Labels
A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jyn514
Copy link
Member

jyn514 commented Feb 11, 2021

I tried this code:

//! Link to [S]

#[doc(no_inline)]
pub use inner::S;

mod inner {
    pub struct S;
}

I expected to see this happen: Rustdoc warns that the links will all be broken

Instead, this happened: Rustdoc gives no warning and generates HTML that looks bad:
image

Meta

rustdoc --version: rustdoc 1.52.0-nightly (9778068 2021-02-07)

@jyn514 jyn514 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-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name labels Feb 11, 2021
nars1 pushed a commit to YottaDB/YDBRust that referenced this issue Jun 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name 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.

2 participants