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: items are shown as if defined in crate when reexported cross-module and cross-crate #27123

Closed
nagisa opened this issue Jul 19, 2015 · 2 comments
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools P-low Low priority T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@nagisa
Copy link
Member

nagisa commented Jul 19, 2015

Consider

extern crate innercrate; //defines only one public item `from_inner_crate`

pub use inner::{inner_fn, from_inner_crate};


/// Top level documentation
pub fn top_level(){}


pub mod inner {
    pub use innercrate::from_inner_crate;
    /// Defined inside inner module
    pub fn inner_fn(){}
}

Documentation renders from_inner_crate as if it was defined at the top level of crate rather than showing it as an reexport from inner module.

what output from rustdoc looks like

@nagisa
Copy link
Member Author

nagisa commented Jul 19, 2015

cc #24305, not sure if any of list items in that meta-issue are duplicates.

@alexcrichton alexcrichton added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jul 20, 2015
@brson brson added A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-tools P-low Low priority labels Jan 26, 2017
@brson
Copy link
Contributor

brson commented Jan 26, 2017

The behavior described in the op is intended. rustdoc does have an option not to inline reexports. If there are missing features still please open a new ticket with further clarification.

@brson brson closed this as completed Jan 26, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools P-low Low priority 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