-
-
Notifications
You must be signed in to change notification settings - Fork 14.8k
Link to private item warning irrelevant in binary crates #89600
Copy link
Copy link
Closed
rust-lang/cargo
#10142Labels
A-diagnosticsArea: Messages for errors, warnings, and lintsArea: Messages for errors, warnings, and lintsA-intra-doc-linksArea: Intra-doc links, the ability to link to items in docs by nameArea: Intra-doc links, the ability to link to items in docs by nameT-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Metadata
Metadata
Assignees
Labels
A-diagnosticsArea: Messages for errors, warnings, and lintsArea: Messages for errors, warnings, and lintsA-intra-doc-linksArea: Intra-doc links, the ability to link to items in docs by nameArea: Intra-doc links, the ability to link to items in docs by nameT-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Type
Fields
Give feedbackNo fields configured for issues without a type.
I get this warning in my binary crate
However,
cargo docby defaults actually documents private items (which I find perfectly reasonable, as this documentation is specifically for other developers to understand the internals).My suggestion is that binary crates should default to
#![allow(rustdoc::private_intra_doc_links)].