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

Please put "see also" links at top, not at bottom. #50384

Closed
ExpHP opened this issue May 2, 2018 · 3 comments
Closed

Please put "see also" links at top, not at bottom. #50384

ExpHP opened this issue May 2, 2018 · 3 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-feature-request Category: A feature request, i.e: not implemented / a PR.

Comments

@ExpHP
Copy link
Contributor

ExpHP commented May 2, 2018

I mean these:

https://doc.rust-lang.org/std/primitive.slice.html -- See also the std::slice module
https://doc.rust-lang.org/std/slice/index.html -- See also the slice primitive type.

These don't belong at the bottom; they aren't there "for further reading." They're more like, hey, is this what you were looking for?

(and the answer is yes. Yes it was. Why do I keep accidentally landing on the std::slice page when I want to see the [T] docs. Why why why.)

@csmoe csmoe added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label May 2, 2018
@kennytm kennytm added A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-feature-request Category: A feature request, i.e: not implemented / a PR. and removed T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels May 2, 2018
@steveklabnik
Copy link
Member

We talked about this at the meeting today, and the general reaction was "I thought they were at the top already". Let's do it!

@ExpHP
Copy link
Contributor Author

ExpHP commented May 9, 2018

I'll put something together. Grepping around, it also seems that str (primitive) hides its link to std::str in prose:

This documentation describes a number of methods and trait implementations on the str type. For technical reasons, there is additional, separate documentation in the std::str module as well.

...technical reasons?

@steveklabnik
Copy link
Member

Thank you! Let's fix it to be consistent with the others.

...technical reasons?

Yeah, it's..... yeah. Anyway, let's drop all of this and just make it identical to the others.

alexcrichton added a commit to alexcrichton/rust that referenced this issue May 10, 2018
alexcrichton added a commit to alexcrichton/rust that referenced this issue May 10, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-feature-request Category: A feature request, i.e: not implemented / a PR.
Projects
None yet
Development

No branches or pull requests

5 participants