Update Arc docs to match new Rc docs #36665

kmcallister · 2016-09-23T02:26:47Z

Rc docs were updated in #36571. This applies similar changes to Arc docs.

frewsxcv · 2016-09-23T03:29:29Z

src/liballoc/arc.rs

 ///
-// See comment at the top of this file for why the test is no_run
+// Note that we **do not** run these tests here. The windows builders get super
+// unhappy of a thread outlives the main thread and then exits at the same time


This still needs to be addressed.

GuillaumeGomez · 2016-09-23T10:32:34Z

src/liballoc/arc.rs

 //!
-//! `Weak<T>` is a weak reference to the `Arc<T>` box, and it is created by


Why removing these lines? We generally have an example at the module level as well. I don't mind changing it but I don't like it to get completely removed.

It seems redundant. Isn't a link to the Arc docs good enough? Besides, the module-level docs are only visible if you're looking at the alloc crate directly and not std.

GuillaumeGomez · 2016-09-25T12:00:54Z

Before r+, what do you think of this @steveklabnik?

steveklabnik · 2016-09-26T19:29:17Z

src/liballoc/arc.rs

 //!
-//! `Weak<T>` is a weak reference to the `Arc<T>` box, and it is created by


So, it's true that duplication isn't great. Usually, module-level docs should have an overview of the whole module, but with modules like these, it's just a container for Arc/Weak, and nothing else. As such, I think I'm fine with removing this in this instance. Especially given the alloc/std split as you mentioned.

steveklabnik

Thanks so much for this! This PR is great, but I have a few nits.

steveklabnik · 2016-09-26T19:29:53Z

src/liballoc/arc.rs

 ///
-// See comment at the top of this file for why the test is no_run
+// Note that we **do not** run these tests here. The windows builders get super
+// unhappy of a thread outlives the main thread and then exits at the same time


This still needs to be addressed.

steveklabnik · 2016-09-26T19:30:09Z

src/liballoc/arc.rs

@@ -1,4 +1,4 @@
-// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
+// Copyright 2012-2016 The Rust Project Developers. See the COPYRIGHT


uuuuuuuuuuuugh these headings.

Yeah... do you want me to leave it alone?

#9070 (comment)

steveklabnik · 2016-09-26T19:30:44Z

src/liballoc/arc.rs

-/// does not use atomics, making it both thread-unsafe as well as significantly
-/// faster when updating the reference count.
+/// The type `Arc<T>` provides shared ownership of a value of type `T`,
+/// allocated in the heap. Invoking [`clone`][clone] on `Arc` produces


these links can be changed to drop the [clone]...

Is that so? I would have to change the link at the bottom to include the backticks, right? And that bugs me personally, although I agree it doesn't really matter.

steveklabnik · 2016-09-26T19:31:07Z

src/liballoc/arc.rs

+/// [arc]: struct.Arc.html
+/// [weak]: struct.Weak.html
+/// [rc]: ../../std/rc/struct.Rc.html
+/// [clone]: ../../std/clone/trait.Clone.html#tymethod.clone


.. and then put

[`clone`]

here.

steveklabnik · 2016-09-26T19:31:24Z

src/liballoc/arc.rs

-/// instead of `value.get_mut()`.  This is so that there are no conflicts with
-/// methods on the inner type `T`, which are what you want to call in the
-/// majority of cases.
+/// Shared pointers in Rust disallow mutation by default, and `Arc` is no


"references" is the proper term.

steveklabnik · 2016-09-26T19:32:25Z

src/liballoc/arc.rs

 ///
 /// ```
-/// use std::sync::Arc;
-/// use std::thread;
+/// # use std::sync::Arc;


I'm a bit torn here. Showing the imports is a bit better, I think: it's less confusing for newer users, and makes it copy/paste able.

kmcallister · 2016-09-27T22:46:07Z

I updated the PR. Let me know what you think, and if it's good, I will squash the Arc changes.

bors · 2016-09-29T10:49:45Z

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

kmcallister · 2016-10-04T17:49:35Z

Rebased, and added one more link in Rc docs.

steveklabnik · 2016-10-06T17:12:01Z

@bors: r+ rollup

Thanks for your patience here @kmcallister

bors · 2016-10-06T17:12:03Z

📌 Commit 29d3e57 has been approved by steveklabnik

kmcallister · 2016-10-07T00:49:57Z

Thanks @steveklabnik! A lot of the delay was on my side, anyway.

@GuillaumeGomez

Update Arc docs to match new Rc docs `Rc` docs were updated in rust-lang#36571. This applies similar changes to `Arc` docs. r? @GuillaumeGomez

Rollup of 5 pull requests - Successful merges: #36222, #36665, #36929, #37003, #37008 - Failed merges:

rust-highfive assigned GuillaumeGomez Sep 23, 2016

frewsxcv approved these changes Sep 23, 2016

View reviewed changes

GuillaumeGomez reviewed Sep 23, 2016

View reviewed changes

steveklabnik approved these changes Sep 26, 2016

View reviewed changes

steveklabnik suggested changes Sep 26, 2016

View reviewed changes

Keegan McAllister added 2 commits October 4, 2016 08:34

Update Arc docs to match new Rc docs

05b6d68

Apply some Arc doc changes to Rc

29d3e57

kmcallister force-pushed the arc-docs branch from b771e21 to 29d3e57 Compare October 4, 2016 17:49

steveklabnik self-assigned this Oct 4, 2016

steveklabnik approved these changes Oct 6, 2016

View reviewed changes

GuillaumeGomez mentioned this pull request Oct 7, 2016

Rollup of 5 pull requests #37024

Merged

bors added a commit that referenced this pull request Oct 7, 2016

Auto merge of #37024 - GuillaumeGomez:rollup, r=GuillaumeGomez

e51190c

Rollup of 5 pull requests - Successful merges: #36222, #36665, #36929, #37003, #37008 - Failed merges:

bors merged commit 29d3e57 into rust-lang:master Oct 7, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Arc docs to match new Rc docs #36665

Update Arc docs to match new Rc docs #36665

kmcallister commented Sep 23, 2016

frewsxcv Sep 23, 2016

steveklabnik Sep 26, 2016

kmcallister Sep 27, 2016

GuillaumeGomez Sep 23, 2016 •

edited

Loading

kmcallister Sep 23, 2016

GuillaumeGomez commented Sep 25, 2016

steveklabnik Sep 26, 2016

steveklabnik left a comment

steveklabnik Sep 26, 2016

steveklabnik Sep 26, 2016

kmcallister Sep 27, 2016

frewsxcv Sep 27, 2016

steveklabnik Sep 26, 2016

kmcallister Sep 27, 2016 •

edited

Loading

steveklabnik Sep 26, 2016

steveklabnik Sep 26, 2016

kmcallister Sep 27, 2016

steveklabnik Sep 26, 2016

GuillaumeGomez Sep 27, 2016

kmcallister Sep 27, 2016

kmcallister commented Sep 27, 2016

bors commented Sep 29, 2016

kmcallister commented Oct 4, 2016

steveklabnik commented Oct 6, 2016

bors commented Oct 6, 2016

kmcallister commented Oct 7, 2016

		//!
		//! `Weak<T>` is a weak reference to the `Arc<T>` box, and it is created by

		@@ -1,4 +1,4 @@
		// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
		// Copyright 2012-2016 The Rust Project Developers. See the COPYRIGHT

Update Arc docs to match new Rc docs #36665

Update Arc docs to match new Rc docs #36665

Conversation

kmcallister commented Sep 23, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuillaumeGomez Sep 23, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuillaumeGomez commented Sep 25, 2016

Choose a reason for hiding this comment

steveklabnik left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kmcallister Sep 27, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kmcallister commented Sep 27, 2016

bors commented Sep 29, 2016

kmcallister commented Oct 4, 2016

steveklabnik commented Oct 6, 2016

bors commented Oct 6, 2016

kmcallister commented Oct 7, 2016

GuillaumeGomez Sep 23, 2016 •

edited

Loading

kmcallister Sep 27, 2016 •

edited

Loading