Skip to content

Improve arc doc, fixing #32905 - #34733

Merged
bors merged 1 commit into
rust-lang:masterfrom
izgzhen:alloc-arc-doc-improve
Jul 15, 2016
Merged

Improve arc doc, fixing #32905#34733
bors merged 1 commit into
rust-lang:masterfrom
izgzhen:alloc-arc-doc-improve

Conversation

@izgzhen

@izgzhenizgzhen commented Jul 9, 2016

Copy link
Copy Markdown
Contributor

As issue #32905 detailed, I moved part of the module doc to the struct doc, and fixed some small places in the alloc::arc.

@rust-highfive

rust-highfive commented Jul 9, 2016

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 @brson (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. Due to 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 the contribution instructions for more information.

izgzhen
izgzhen reviewed Jul 9, 2016
View reviewed changes
Comment threadsrc/liballoc/arc.rs Outdated

@izgzhenizgzhenJul 9, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not clear what does pipes really mean here, any comments?

@steveklabniksteveklabnikJul 11, 2016

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.

I think it's referring to channels, but we can probably just remove the whole sentence.

@izgzhenizgzhenJul 11, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing looks good to me. It might be a distraction I suppose.

@izgzhen

izgzhen commented Jul 9, 2016

Copy link
Copy Markdown
ContributorAuthor

Note that I marked the pipes in the diff and had some problem in how to handling this.

@brson

brson commented Jul 11, 2016

Copy link
Copy Markdown
Contributor

lgtm when @steveklabnik's comments addressed

izgzhen
izgzhen reviewed Jul 12, 2016
View reviewed changes
Comment threadsrc/liballoc/arc.rs
/// increase the reference counter.
/// In this example, a large vector of data will be shared by several threads. First we
/// wrap it with a `Arc::new` and then clone the `Arc<T>` reference for every thread (which will
/// increase the reference count atomically).

@izgzhenizgzhenJul 12, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@steveklabnik How about this?

@steveklabnik

steveklabnik commented Jul 12, 2016

Copy link
Copy Markdown
Contributor

Looks good, thanks a ton!

@bors: r+ rollup

@bors

bors commented Jul 12, 2016

Copy link
Copy Markdown
Collaborator

📌 Commit a6ff05c has been approved by steveklabnik

@GuillaumeGomezGuillaumeGomez mentioned this pull request Jul 14, 2016
Merged
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jul 15, 2016
@GuillaumeGomez
Rollup merge ofrust-lang#34733- izgzhen:alloc-arc-doc-improve, r=st…
257b351
…eveklabnik
Improve arc doc, fixing rust-lang#32905
As issue rust-lang#32905 detailed, I moved part of the module doc to the struct doc, and fixed some small places in the `alloc::arc`.
bors added a commit that referenced this pull request Jul 15, 2016
@bors
Auto merge of#34819- GuillaumeGomez:rollup, r=GuillaumeGomez
3cc3ad1
Rollup of 7 pull requests
- Successful merges: #34456, #34733, #34777, #34794, #34799, #34804, #34818
- Failed merges: #33951
@bors
bors merged commit a6ff05c into rust-lang:masterJul 15, 2016
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@steveklabniksteveklabnik

@brsonbrson

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@izgzhen@rust-highfive@brson@steveklabnik@bors