-
Notifications
You must be signed in to change notification settings - Fork 12.8k
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
Comments
This is because |
(I don't know when this was changed but it was long ago, I think when @alexcrichton was fixing up rustdoc) |
No, they're not hidden. Look at They simply lack of documentation, not hidden. |
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. |
Ah. I would still prefer that they just be shown, personally. |
Ah, okay. Though, the docs on impl blocks certainly are missing. |
Somewhat related: #23271 |
Related: #24838 |
Triage: no changes |
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! |
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>
forchar
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.The text was updated successfully, but these errors were encountered: