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

Small updates to slice, str, io docs #23664

Merged
merged 3 commits into from
Mar 25, 2015
Merged

Small updates to slice, str, io docs #23664

merged 3 commits into from
Mar 25, 2015

Conversation

bluss
Copy link
Member

@bluss bluss commented Mar 24, 2015

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.

@rust-highfive
Copy link
Collaborator

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.

@bluss
Copy link
Member Author

bluss commented Mar 24, 2015

Point of discussion: Instead of saying StrExt::split it now refers to str::split. This is actually UFCS-callable which is really nice. The type vs module confusion might otherwise make it a bit confusing, but it's meant to be read as "the method split on type str."

//! * Further iterators exist that split, chunk or permute the slice.
//! The mutable slice yields mutable references to the elements:
//!
//! ```rust
Copy link
Member

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

@steveklabnik
Copy link
Member

Thank you! this is pretty great, r=me after we handle the nits

@nikomatsakis
Copy link
Contributor

r? @steveklabnik

@nikomatsakis
Copy link
Contributor

(I was just changing the assignment)

@bluss
Copy link
Member Author

bluss commented Mar 24, 2015

Thank you for the review, fixed the nits! I changed the parse sentence to call it a method though.

@steveklabnik
Copy link
Member

Would you mind squashing? sorry

@bluss
Copy link
Member Author

bluss commented Mar 24, 2015

Squashed into three commits again.

@bors
Copy link
Contributor

bors commented Mar 24, 2015

☔ The latest upstream changes (presumably #23654) made this pull request unmergeable. Please resolve the merge conflicts.

Ulrik Sverdrup added 3 commits March 24, 2015 22:20
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.
@bluss
Copy link
Member Author

bluss commented Mar 24, 2015

Rebased to new master.

@Manishearth
Copy link
Member

@bors: r=steveklabnik rollup

Looks like everything was addressed. Thanks!

@bors
Copy link
Contributor

bors commented Mar 25, 2015

📌 Commit 547a48e has been approved by steveklabnik

Manishearth added a commit to Manishearth/rust that referenced this pull request Mar 25, 2015
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.
bors added a commit that referenced this pull request Mar 25, 2015
@bors bors merged commit 547a48e into rust-lang:master Mar 25, 2015
@bluss bluss deleted the std-docs branch March 25, 2015 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants