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

Documentation of libstd is lacking of comments on trait implementations #31821

Closed
ticki opened this issue Feb 22, 2016 · 10 comments
Closed

Documentation of libstd is lacking of comments on trait implementations #31821

ticki opened this issue Feb 22, 2016 · 10 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. P-medium Medium priority T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@ticki
Copy link
Contributor

ticki commented Feb 22, 2016

Currently, a lot of the implementation on types in libstd is unexplained, and the behavior of these are not always obvious.

For example,PartialOrd<char> for char is unexplained. Since the exact behavior can unobvious in this case, it should be properly documented (that it compares the unicode codepoints, based on their value). This is just one of the many undocumented implementations in libstd.

@steveklabnik
Copy link
Member

This is because rustdoc currently hides them, even if they're there.

@steveklabnik steveklabnik added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Feb 22, 2016
@steveklabnik
Copy link
Member

(I don't know when this was changed but it was long ago, I think when @alexcrichton was fixing up rustdoc)

@ticki
Copy link
Contributor Author

ticki commented Feb 22, 2016

No, they're not hidden. Look at impl Rem<u32> for u32 in https://doc.rust-lang.org/std/primitive.u32.html.

They simply lack of documentation, not hidden.

@bluss
Copy link
Member

bluss commented Feb 22, 2016

Docs on impl methods are hidden, doc on impl block is not. Some impls contain docs that need to be moved to the impl block.

@steveklabnik
Copy link
Member

Ah.

I would still prefer that they just be shown, personally.

@ticki
Copy link
Contributor Author

ticki commented Feb 22, 2016

Ah, okay. Though, the docs on impl blocks certainly are missing.

@frewsxcv
Copy link
Member

Somewhat related: #23271

@mitaa
Copy link
Contributor

mitaa commented Feb 23, 2016

Related: #24838

@steveklabnik steveklabnik added T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. and removed T-tools labels May 18, 2017
@Mark-Simulacrum Mark-Simulacrum added C-enhancement Category: An issue proposing an enhancement or a PR with one. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Jul 24, 2017
@steveklabnik steveklabnik added the P-medium Medium priority label Aug 30, 2017
@steveklabnik
Copy link
Member

Triage: no changes

@steveklabnik
Copy link
Member

Triage: this is too broad and vague to be useful. If you'd like to see a specific implementation documented better, please open issues that are specific to that impl, or if you'd like to do an audit of every useful one, get in touch and we can see how to tackle it. Thank you!

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-enhancement Category: An issue proposing an enhancement or a PR with one. P-medium Medium priority T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/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

6 participants