Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.
Sign upPublic items re-exported publicly in the same crate could have inlined docs #22310
Comments
steveklabnik
added
the
T-rustdoc
label
Feb 14, 2015
This comment has been minimized.
This comment has been minimized.
|
This appears to cause [incidentally, I strongly dislike the |
brson
added
I-wrong
labels
Sep 22, 2016
steveklabnik
added
T-tools
and removed
T-tools
labels
Mar 9, 2017
steveklabnik
added
T-dev-tools
and removed
T-tools
labels
May 18, 2017
Mark-Simulacrum
added
C-feature-request
and removed
C-enhancement
I-wrong
labels
Jul 22, 2017
This comment has been minimized.
This comment has been minimized.
|
This issue still exists, but I would consider it partly by design. Right now, rustdoc will create a "Reexports" section that prints each I'll keep this issue open, if only for "add reexports into the search index under their new paths as well as their original ones". |
tomjakubowski commentedFeb 13, 2015
As an example of what I mean, see this page: http://doc.rust-lang.org/syntax/parse/lexer/index.html
There is a re-exports section:
All of those items are public and reachable, so they're documented in
ext::tt::transcribe. Butlexer::new_tt_reader, for example, does not appear in the search index and (less seriously) it's a little annoying to have to jump through another set of links to another page to read the docs for that function.When a private item is re-exported publicly in the same crate, or a public item from another crate is re-exported, the docs are inlined and an entry is created in the search index. I think it would be reasonable to do the same for public intra-crate re-exports.