Skip to content

rustdoc: link implemented methods appropriately #17476

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

Closed
nodakai opened this issue Sep 23, 2014 · 0 comments
Closed

rustdoc: link implemented methods appropriately #17476

nodakai opened this issue Sep 23, 2014 · 0 comments
Assignees
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@nodakai
Copy link
Contributor

nodakai commented Sep 23, 2014

Example: we see char implements the Char trait which provides encode_utf8():

However it isn't easy to browse to its description; Curretnly we must

  1. move up to the line of impl Char for char,
  2. click Char to open a new page,
  3. and then find encode_utf8() in the new page.

We should be able to

  1. just click encode_utf8() to open its description without any manual scrolling

Curretnly encode_utf8() in the char page is linked to itself. Perhaps the intention was to provide an easy way for a person reading it with a web browser to copy the link into the OS clipboard. However it is a less likely use case than to try to read the description of each trait method. I think it is convenient enought to link the char part of the impl Char for char line to the same line.

@steveklabnik steveklabnik added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jan 27, 2015
@alexcrichton alexcrichton self-assigned this Apr 7, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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