Skip to content

Small updates to slice, str, io docs - #23664

Merged
bors merged 3 commits into
rust-lang:masterfrom
bluss:std-docs
Mar 25, 2015
Merged

Small updates to slice, str, io docs#23664
bors merged 3 commits into
rust-lang:masterfrom
bluss:std-docs

Conversation

@bluss

@blussbluss commented Mar 24, 2015

Copy link
Copy Markdown
Contributor

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

rust-highfive commented Mar 24, 2015

Copy link
Copy Markdown
Contributor

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

bluss commented Mar 24, 2015

Copy link
Copy Markdown
ContributorAuthor

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."

steveklabnik
steveklabnik reviewed Mar 24, 2015
View reviewed changes
Comment threadsrc/libcollections/slice.rs Outdated

@steveklabniksteveklabnikMar 24, 2015

Copy link
Copy Markdown
Contributor

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

steveklabnik commented Mar 24, 2015

Copy link
Copy Markdown
Contributor

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

@nikomatsakis

nikomatsakis commented Mar 24, 2015

Copy link
Copy Markdown
Contributor

r? @steveklabnik

@nikomatsakis

nikomatsakis commented Mar 24, 2015

Copy link
Copy Markdown
Contributor

(I was just changing the assignment)

@bluss

bluss commented Mar 24, 2015

Copy link
Copy Markdown
ContributorAuthor

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

@steveklabnik

steveklabnik commented Mar 24, 2015

Copy link
Copy Markdown
Contributor

Would you mind squashing? sorry

@bluss

bluss commented Mar 24, 2015

Copy link
Copy Markdown
ContributorAuthor

Squashed into three commits again.

@bors

bors commented Mar 24, 2015

Copy link
Copy Markdown
Collaborator

☔ 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
Ulrik Sverdrup
std: Update docs for removal of ReadExt, WriteExt
227d304
Ulrik Sverdrup
core: Update docs for StrExt demotion in libstd
00e14f1
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).
Ulrik Sverdrup
collections: Update docs for slice since SliceExt was removed
547a48e
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

bluss commented Mar 24, 2015

Copy link
Copy Markdown
ContributorAuthor

Rebased to new master.

@Manishearth

Manishearth commented Mar 25, 2015

Copy link
Copy Markdown
Member

@bors: r=steveklabnik rollup

Looks like everything was addressed. Thanks!

@bors

bors commented Mar 25, 2015

Copy link
Copy Markdown
Collaborator

📌 Commit 547a48e has been approved by steveklabnik

Manishearth added a commit to Manishearth/rust that referenced this pull request Mar 25, 2015
@Manishearth
Rollup merge ofrust-lang#23664- bluss:std-docs, r=steveklabnik
5535767
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.
@ManishearthManishearth mentioned this pull request Mar 25, 2015
Merged
bors added a commit that referenced this pull request Mar 25, 2015
@bors
Auto merge of#23697- Manishearth:rollup, r=Manishearth
a923278
- Successful merges: #23617, #23664, #23680, #23684, #23692, #23693
- Failed merges:
@bors
bors merged commit 547a48e into rust-lang:masterMar 25, 2015
@bluss
bluss deleted the std-docs branch March 25, 2015 19:14
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@steveklabniksteveklabnik

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@bluss@rust-highfive@steveklabnik@nikomatsakis@bors@Manishearth