-
Notifications
You must be signed in to change notification settings - Fork 13k
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
Small updates to slice, str, io docs #23664
Conversation
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @nikomatsakis (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. The way Github handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see CONTRIBUTING.md for more information. |
Point of discussion: Instead of saying |
//! * Further iterators exist that split, chunk or permute the slice. | ||
//! The mutable slice yields mutable references to the elements: | ||
//! | ||
//! ```rust |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
covention is to not include rust
in API docs like this. I know it's strewn about with the rest of the file, but we shouldn't introduce new ones
Thank you! this is pretty great, r=me after we handle the nits |
(I was just changing the assignment) |
Thank you for the review, fixed the nits! I changed the parse sentence to call it a method though. |
Would you mind squashing? sorry |
Squashed into three commits again. |
☔ The latest upstream changes (presumably #23654) made this pull request unmergeable. Please resolve the merge conflicts. |
Main access point of .split() and other similar methods are not using the StrExt trait anymore, so update the libcore docs to reflect this (because these docs are visible in libstd API documentation).
A lot has changed since this doc text was last touched up, and this is just a minor edit. I remove the trait section entirely since we don't use extension traits that much anymore, so there are no significant trait hilights for this module.
Rebased to new master. |
@bors: r=steveklabnik rollup Looks like everything was addressed. Thanks! |
📌 Commit 547a48e has been approved by |
Main motivation was to update docs for the removal or "demotion" of certain extension traits. The update to the slice docs was larger, since the text was largely outdated.
Main motivation was to update docs for the removal or "demotion" of certain extension traits. The update to the slice docs was larger, since the text was largely outdated.