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 should not use full paths to name mods in the TOC #1954

Closed
brson opened this issue Mar 10, 2012 · 5 comments
Closed

rustdoc should not use full paths to name mods in the TOC #1954

brson opened this issue Mar 10, 2012 · 5 comments
Labels
C-cleanup Category: PRs that clean code up or issues documenting cleanup. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@brson
Copy link
Contributor

brson commented Mar 10, 2012

http://doc.rust-lang.org/doc/core/vec.html

Mods and native mods are named by their full path in the TOC, while other items are not.

@ghost ghost assigned brson Mar 10, 2012
@sanxiyn
Copy link
Member

sanxiyn commented Apr 23, 2013

I don't understand the issue. Can you clarify?

@alexcrichton
Copy link
Member

@brson, this looks to be a non-issue now. All the headings are "Function XXX" without any sort of module prefix in front. Is this what the bug was targeting?

@thestinger
Copy link
Contributor

The documentation mentions the traits with their full path:

Module vec::bytes - Operations on [u8]
Module vec::raw - Unsafe operations
Module vec::rustrt
Module vec::traits

The vec:: should be omitted as it is for the other items.

@emberian
Copy link
Member

#8125

This is fixed by rustdoc_ng.

@alexcrichton
Copy link
Member

Closing, now that rustdoc_ng is in-tree and generating docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-cleanup Category: PRs that clean code up or issues documenting cleanup. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. 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

5 participants