Skip to content

Simplify rustdoc URLs #34271

@nrc

Description

@nrc
Member

The URLs for items in Rustdoc are Byzantine combinations of the kind of item, the parent (module/struct/enum, etc) and the name of the item. These are impossible for tools to synthesise without deep knowledge of the program structure (and pretty difficult even with that knowledge). They should be much simpler.

Question: are there any advantages of the current scheme?

Activity

added
T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
on Jun 14, 2016
steveklabnik

steveklabnik commented on Jun 14, 2016

@steveklabnik
Member

I find them kind of okay to write by hand. Not great, but not terrible. Would welcome improvements.

On Jun 14, 2016, 10:07 +0100, Nick Cameronnotifications@github.com, wrote:

The URLs for items in Rustdoc are Byzantine combinations of the kind of item, the parent (module/struct/enum, etc) and the name of the item. These are impossible for tools to synthesise without deep knowledge of the program structure (and pretty difficult even with that knowledge). They should be much simpler.

Question: are there any advantages of the current scheme?


You are receiving this because you are subscribed to this thread.
Reply to this email directly,view it on GitHub(#34271), ormute the thread(https://github.com/notifications/unsubscribe/AABsiqyHb-9OOX3034jYSp-lshOv3qlBks5qLm9YgaJpZM4I1G6Q).

alexcrichton

alexcrichton commented on Jun 14, 2016

@alexcrichton
Member

I personally type the path specifically with modules (e.g. /std/net/) although I'd also be fine if we emitted a bunch more redirect pages like /__redirect/<id>.html which just goes to the right place.

steveklabnik

steveklabnik commented on Dec 22, 2016

@steveklabnik
Member

Triage: I talked extremely briefly with @nrc two weeks ago in Hawaii and I vaguely remember him saying "yeah we're giving up on this." Is this true? Should this be closed? My memory is very likely to be faulty.

steveklabnik

steveklabnik commented on Dec 22, 2016

@steveklabnik
Member

Oh wait, #35236 was a re-do of #35020 which was supposed to close this. So I think this should be closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

        Participants

        @steveklabnik@alexcrichton@nrc

        Issue actions

          Simplify rustdoc URLs · Issue #34271 · rust-lang/rust