-
-
Notifications
You must be signed in to change notification settings - Fork 14.9k
Many times re-exported type shows wrong documentation page #37608
Copy link
Copy link
Closed
Labels
T-dev-toolsRelevant to the dev-tools subteam, which will review and decide on the PR/issue.Relevant to the dev-tools subteam, which will review and decide on the PR/issue.T-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
T-dev-toolsRelevant to the dev-tools subteam, which will review and decide on the PR/issue.Relevant to the dev-tools subteam, which will review and decide on the PR/issue.T-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.
When a crate B re-exports a type from another crate A under a different name in a private module, and defines a new type with the same name, and the type from the private module is re-exported in a public module using a wildcard, and the other type is also re-exported in that same public module, and a crate C re-exports this public module, the documentation page for that named type for crate C shows the wrong type when the documentation is compiled including dependencies.
Man, that's a mouthful. Here is some code to clarify:
The documentation for
c::public::Sshows the documentation fora::Sbut the actual type isb::private::S. There is no page forc::public::X.This shows up in the wild in the documentation for
iron::headers::Cookie, which ishyper::header::Cookiebut showscookie::Cookie.I don't think this is one of the issues already documented in #24305