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.

Sign up for GitHub

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

Jump to bottom

API Docs: std::str #29375

Closed
11 tasks
steveklabnik opened this issue Oct 26, 2015 · 13 comments · Fixed by #40682
Closed
11 tasks

API Docs: std::str #29375

steveklabnik opened this issue Oct 26, 2015 · 13 comments · Fixed by #40682
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools E-help-wanted Call for participation: Help is requested to fix this issue. E-medium Call for participation: Medium difficulty. Experience needed to fix: Intermediate. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. P-medium Medium priority

Comments

@steveklabnik
Copy link
Member

steveklabnik commented Oct 26, 2015 •
edited
Loading

Part of #29329

http://doc.rust-lang.org/std/str/

Here's what needs to be done to close out this issue:
@steveklabnik steveklabnik mentioned this issue Oct 26, 2015
Closed
51 tasks
@steveklabnik steveklabnik mentioned this issue Nov 19, 2015
Closed
@steveklabnik
Copy link
Member Author

As shown in #30057, there's a lot of junk there that could be in Pattern instead.

@steveklabnik steveklabnik added the E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. label Mar 8, 2017
@steveklabnik
Copy link
Member Author

I am happy to mentor anyone who wants to tackle this issue.

@steveklabnik steveklabnik added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Mar 10, 2017
@tigleym
Copy link
Contributor

tigleym commented Mar 18, 2017

Hello! I'd like to give this issue a try.

@steveklabnik
Copy link
Member Author

@tigleym that'd be great! this issue is very general, so any improvements would be welcome. Let me know if you need any help!

@tigleym tigleym mentioned this issue Mar 20, 2017
Merged
@steveklabnik steveklabnik added P-medium Medium priority E-help-wanted Call for participation: Help is requested to fix this issue. E-medium Call for participation: Medium difficulty. Experience needed to fix: Intermediate. and removed A-docs labels Mar 24, 2017
This was referenced Mar 25, 2017
Merged
Merged
frewsxcv added a commit to frewsxcv/rust that referenced this issue Mar 26, 2017
@frewsxcv
Rollup merge of rust-lang#40824 - donniebishop:fromstr_docexample, r=…
2d01cfb 
…steveklabnik

FromStr implementation example

Referencing rust-lang#29375. Added example implementation of FromStr trait to API Documentation
alexcrichton added a commit to alexcrichton/rust that referenced this issue Mar 27, 2017
@alexcrichton
Rollup merge of rust-lang#40819 - donniebishop:master, r=alexcrichton
84712fa 
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
alexcrichton added a commit to alexcrichton/rust that referenced this issue Mar 27, 2017
@alexcrichton
Rollup merge of rust-lang#40824 - donniebishop:fromstr_docexample, r=…
6b2c4bf 
…steveklabnik

FromStr implementation example

Referencing rust-lang#29375. Added example implementation of FromStr trait to API Documentation
frewsxcv added a commit to frewsxcv/rust that referenced this issue Mar 29, 2017
@frewsxcv
Rollup merge of rust-lang#40682 - TigleyM:str_doc, r=steveklabnik
f79c794 
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
frewsxcv added a commit to frewsxcv/rust that referenced this issue Mar 29, 2017
@frewsxcv
Rollup merge of rust-lang#40682 - TigleyM:str_doc, r=steveklabnik
378d230 
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
@donniebishop
Copy link
Contributor

@steveklabnik Shouldn't this remain open? 3 points have been hit on, but the rest of the bullets need to be addressed

@steveklabnik steveklabnik reopened this Mar 29, 2017
@steveklabnik
Copy link
Member Author

Yes, whoops! That was an auto-close from a PR message; gotta be careful with that!

@donniebishop donniebishop mentioned this issue Mar 29, 2017
Merged
frewsxcv added a commit to frewsxcv/rust that referenced this issue Mar 29, 2017
@frewsxcv
Rollup merge of rust-lang#40907 - donniebishop:utf8_unchecked_docs, r…
fb6ced4 
…=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`
@donniebishop donniebishop mentioned this issue Apr 1, 2017
Merged
@donniebishop
Copy link
Contributor

donniebishop commented Apr 1, 2017 •
edited
Loading

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!

frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 2, 2017
@frewsxcv
Rollup merge of rust-lang#40992 - donniebishop:utf8err_linking, r=ale…
7b9f860 
…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
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 2, 2017
@frewsxcv
Rollup merge of rust-lang#40997 - donniebishop:from_utf8_linking, r=s…
eb6e9dd 
…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.
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 2, 2017
@frewsxcv
Rollup merge of rust-lang#40992 - donniebishop:utf8err_linking, r=ale…
03b81a1 
…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
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 2, 2017
@frewsxcv
Rollup merge of rust-lang#40997 - donniebishop:from_utf8_linking, r=s…
17e106f 
…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.
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 3, 2017
@frewsxcv
Rollup merge of rust-lang#40992 - donniebishop:utf8err_linking, r=ale…
b51c991 
…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
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 3, 2017
@frewsxcv
Rollup merge of rust-lang#40997 - donniebishop:from_utf8_linking, r=s…
148afae 
…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.
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 3, 2017
@frewsxcv
Rollup merge of rust-lang#40992 - donniebishop:utf8err_linking, r=ale…
fd37622 
…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
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 3, 2017
@frewsxcv
Rollup merge of rust-lang#40997 - donniebishop:from_utf8_linking, r=s…
2a01b3e 
…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.
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 3, 2017
@frewsxcv
Rollup merge of rust-lang#40992 - donniebishop:utf8err_linking, r=ale…
da961f2 
…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
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 3, 2017
@frewsxcv
Rollup merge of rust-lang#40997 - donniebishop:from_utf8_linking, r=s…
8f4c789 
…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.
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 4, 2017
@frewsxcv
Rollup merge of rust-lang#40992 - donniebishop:utf8err_linking, r=ale…
4d5e7d4 
…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
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 4, 2017
@frewsxcv
Rollup merge of rust-lang#40997 - donniebishop:from_utf8_linking, r=s…
829deab 
…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.
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 4, 2017
@frewsxcv
Rollup merge of rust-lang#40992 - donniebishop:utf8err_linking, r=ale…
8bf71fd 
…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
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 4, 2017
@frewsxcv
Rollup merge of rust-lang#40997 - donniebishop:from_utf8_linking, r=s…
8ca07cf 
…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.
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 5, 2017
@frewsxcv
Rollup merge of rust-lang#40992 - donniebishop:utf8err_linking, r=ale…
9fb1ddd 
…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
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 5, 2017
@frewsxcv
Rollup merge of rust-lang#40997 - donniebishop:from_utf8_linking, r=s…
800b85e 
…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.
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 5, 2017
@frewsxcv
Rollup merge of rust-lang#40992 - donniebishop:utf8err_linking, r=ale…
fd474f0 
…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
frewsxcv added a commit to frewsxcv/rust that referenced this issue Apr 5, 2017
@frewsxcv
Rollup merge of rust-lang#40997 - donniebishop:from_utf8_linking, r=s…
325848a 
…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.
@donniebishop
Copy link
Contributor

Everything's merged! Good to close @steveklabnik?

@steveklabnik
Copy link
Member Author

Yes! 🎊

Thank you for all the help!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools E-help-wanted Call for participation: Help is requested to fix this issue. E-medium Call for participation: Medium difficulty. Experience needed to fix: Intermediate. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. P-medium Medium priority
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update docs for std::str
3 participants
@steveklabnik @donniebishop @tigleym