Skip to content

Rustdoc URLs should more precisely match internal structure #25226

Closed
@withoutboats

Description

@withoutboats

For modules, the URLs generated by rustdoc correlate correctly with the module structure, but the same is not true for types. It would be better if, instead of generating std/collections/struct.HashMap.html, rustdoc generated std/collections/HashMap. This would enable anyone who knows the website at which the documentation for their library is stored and the namespace object they wish to look up to navigate to this page with ease. Similarly, methods should probably drop the method. prefix, and be found such as std/collections/HashMap#contains_key.

The .html affix conveys no useful information at all, and the struct. prefix conveys information which is not helpful for disambiguating this page from other pages in the documentation hierarchy.

The exception to this seems to be the strange std/primitive.char.html pages. I don't exactly know how these are generated, and they are difficult to locate already in the documentation generated by rustdoc; at very least these should be at std/primitive.char, without the .html.

If this change is considered valuable, it seems somewhat high priority to limit the number of links that will exist to current page schemes as Rust continues to gain momentum post-1.0

As an addendum, I want to say that rustdoc is the best doc system of any language I've used and an incredible, bountiful asset to Rust.

Metadata

Metadata

Assignees

No one assigned

    Labels

    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions