-
Notifications
You must be signed in to change notification settings - Fork 12.7k
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
API Docs: std::str #29375
Comments
As shown in #30057, there's a lot of junk there that could be in |
I am happy to mentor anyone who wants to tackle this issue. |
Hello! I'd like to give this issue a try. |
@tigleym that'd be great! this issue is very general, so any improvements would be welcome. Let me know if you need any help! |
…steveklabnik FromStr implementation example Referencing rust-lang#29375. Added example implementation of FromStr trait to API Documentation
Link ParseBoolError to from_str method of bool Referencing task in rust-lang#29375. Sorry for not opening another branch on my fork for this. Was working on this early this morning and forgot to branch off master
…steveklabnik FromStr implementation example Referencing rust-lang#29375. Added example implementation of FromStr trait to API Documentation
Update docs for std::str fixes rust-lang#29375 I noticed there are docs for the `str` primitive type, which contained extensive examples, so my additions give a more general explanation of `&str`. But please let me know if something can be explained more or changed. r? @steveklabnik
Update docs for std::str fixes rust-lang#29375 I noticed there are docs for the `str` primitive type, which contained extensive examples, so my additions give a more general explanation of `&str`. But please let me know if something can be explained more or changed. r? @steveklabnik
@steveklabnik Shouldn't this remain open? 3 points have been hit on, but the rest of the bullets need to be addressed |
Yes, whoops! That was an auto-close from a PR message; gotta be careful with that! |
…=steveklabnik Linked str in from_utf_unchecked References rust-lang#29375. Linked `str` in from_utf_unchecked's documentation to the docs for primitive `str`
I think the last two PRs should take care of the remaining bits of the task list. When they're merged, I think we'll be good to close this issue out!
|
…xcrichton Added links to from_utf8 methods in Utf8Error Referencing rust-lang#29375. Linked the `from_utf8` methods for both `String` and `str` in the description. Also linked the `u8` to its documentation
…teveklabnik Added links to types in from_utf8 description References rust-lang#29375. Link to types mentioned in the documentation for `from_utf8` (`str`, `&[u8`], etc). Paragraphs were reformatted to keep any one line from being excessively long, but are otherwise unchanged.
…xcrichton Added links to from_utf8 methods in Utf8Error Referencing rust-lang#29375. Linked the `from_utf8` methods for both `String` and `str` in the description. Also linked the `u8` to its documentation
…teveklabnik Added links to types in from_utf8 description References rust-lang#29375. Link to types mentioned in the documentation for `from_utf8` (`str`, `&[u8`], etc). Paragraphs were reformatted to keep any one line from being excessively long, but are otherwise unchanged.
…xcrichton Added links to from_utf8 methods in Utf8Error Referencing rust-lang#29375. Linked the `from_utf8` methods for both `String` and `str` in the description. Also linked the `u8` to its documentation
…teveklabnik Added links to types in from_utf8 description References rust-lang#29375. Link to types mentioned in the documentation for `from_utf8` (`str`, `&[u8`], etc). Paragraphs were reformatted to keep any one line from being excessively long, but are otherwise unchanged.
…xcrichton Added links to from_utf8 methods in Utf8Error Referencing rust-lang#29375. Linked the `from_utf8` methods for both `String` and `str` in the description. Also linked the `u8` to its documentation
…teveklabnik Added links to types in from_utf8 description References rust-lang#29375. Link to types mentioned in the documentation for `from_utf8` (`str`, `&[u8`], etc). Paragraphs were reformatted to keep any one line from being excessively long, but are otherwise unchanged.
…xcrichton Added links to from_utf8 methods in Utf8Error Referencing rust-lang#29375. Linked the `from_utf8` methods for both `String` and `str` in the description. Also linked the `u8` to its documentation
…teveklabnik Added links to types in from_utf8 description References rust-lang#29375. Link to types mentioned in the documentation for `from_utf8` (`str`, `&[u8`], etc). Paragraphs were reformatted to keep any one line from being excessively long, but are otherwise unchanged.
…xcrichton Added links to from_utf8 methods in Utf8Error Referencing rust-lang#29375. Linked the `from_utf8` methods for both `String` and `str` in the description. Also linked the `u8` to its documentation
…teveklabnik Added links to types in from_utf8 description References rust-lang#29375. Link to types mentioned in the documentation for `from_utf8` (`str`, `&[u8`], etc). Paragraphs were reformatted to keep any one line from being excessively long, but are otherwise unchanged.
…xcrichton Added links to from_utf8 methods in Utf8Error Referencing rust-lang#29375. Linked the `from_utf8` methods for both `String` and `str` in the description. Also linked the `u8` to its documentation
…teveklabnik Added links to types in from_utf8 description References rust-lang#29375. Link to types mentioned in the documentation for `from_utf8` (`str`, `&[u8`], etc). Paragraphs were reformatted to keep any one line from being excessively long, but are otherwise unchanged.
…xcrichton Added links to from_utf8 methods in Utf8Error Referencing rust-lang#29375. Linked the `from_utf8` methods for both `String` and `str` in the description. Also linked the `u8` to its documentation
…teveklabnik Added links to types in from_utf8 description References rust-lang#29375. Link to types mentioned in the documentation for `from_utf8` (`str`, `&[u8`], etc). Paragraphs were reformatted to keep any one line from being excessively long, but are otherwise unchanged.
…xcrichton Added links to from_utf8 methods in Utf8Error Referencing rust-lang#29375. Linked the `from_utf8` methods for both `String` and `str` in the description. Also linked the `u8` to its documentation
…teveklabnik Added links to types in from_utf8 description References rust-lang#29375. Link to types mentioned in the documentation for `from_utf8` (`str`, `&[u8`], etc). Paragraphs were reformatted to keep any one line from being excessively long, but are otherwise unchanged.
Everything's merged! Good to close @steveklabnik? |
Yes! 🎊 Thank you for all the help! |
Part of #29329
http://doc.rust-lang.org/std/str/
Here's what needs to be done to close out this issue:
std::str
and the primitive type are different.Bytes
should use the same boilerplate asLines
Modify str Structs descriptions #40935 (review)CharIndices
has the same issue. Modify str Structs descriptions #40935 (review)Chars
has the same issue. Modify str Structs descriptions #40935 (review)EncodeUtf16
has the same issue. Modify str Structs descriptions #40935 (review)ParseBoolError
should link to the method it comes from.SplitWhitespace
should use the same boilerplate asLines
.Utf8Error
should link to those functions.FromStr
should have an example of implementing it.from_utf8
should link the types it mentions.from_utf8_unchecked
should link that&str
.The text was updated successfully, but these errors were encountered: