Adding links and examples for various mspc pages #29377 #41438

projektir · 2017-04-21T03:55:35Z

Adding links and copying examples for the various Iterators; adding some extra stuff to Sender/SyncSender/Receiver.

rust-highfive · 2017-04-21T03:55:48Z

r? @brson

(rust_highfive has picked a reviewer for you, use r? to override)

shepmaster · 2017-04-21T14:09:47Z

Thanks for the pull request @projektir! We'll make sure that @brson or another reviewer take a look at this in a reasonable amount of time.

alexcrichton · 2017-04-21T15:53:56Z

@projektir looks like the travis tests may be failing? Other than that looks good to me!

chordowl

Some small nits, but this looks good to me overall! Thanks @projektir 😁

Edit: oops, didn't add all the comments...

chordowl · 2017-04-21T18:38:38Z

src/libstd/sync/mpsc/mod.rs

+/// let mut msg;
+///
+/// msg = receiver.recv().unwrap();
+/// assert_eq!(1, msg);


This line is failing the test because there is a race condition.

chordowl · 2017-04-21T18:52:00Z

src/libstd/sync/mpsc/mod.rs

-/// An iterator over messages on a receiver, this iterator will block whenever
-/// [`next`] is called, waiting for a new message, and [`None`] will be returned
+/// An iterator over messages on a [`Receiver`], created by [`iter`].
+/// This iterator will block whenever [`next`] is called,


Can you put a newline after the first sentence? The summary is quite long otherwise.

chordowl · 2017-04-21T18:52:12Z

src/libstd/sync/mpsc/mod.rs

-/// [`None`] will be returned when there are no pending values remaining or if
-/// the corresponding channel has hung up.
+/// An iterator that attempts to yield all pending values for a [`Receiver`],
+/// created by [`try_iter`]. [`None`] will be returned when there


Same as above

chordowl · 2017-04-21T18:52:52Z

src/libstd/sync/mpsc/mod.rs

-/// whenever [`next`] is called, waiting for a new message, and [`None`] will be
-/// returned when the corresponding channel has hung up.
+/// An owning iterator over messages on a [`Receiver`],
+/// created by **Receiver::into_iter**. This iterator will block whenever [`next`]


Same as above. Can you also make into_iter into a link and format it the same way as you did for the summaries for Iter and TryIter?

projektir · 2017-04-22T17:01:21Z

@lukaramu this should be good for another review now.

chordowl

Looks good to me now! 👌

alexcrichton · 2017-04-24T15:06:35Z

@bors: r+

bors · 2017-04-24T15:06:36Z

📌 Commit d7efbec has been approved by alexcrichton

Adding links and examples for various mspc pages rust-lang#29377 Adding links and copying examples for the various Iterators; adding some extra stuff to `Sender`/`SyncSender`/`Receiver`.

frewsxcv · 2017-04-25T00:57:28Z

src/libstd/sync/mpsc/mod.rs

@@ -949,16 +1145,17 @@ impl<T> Receiver<T> {
    ///
    /// This function will always block the current thread if there is no data
    /// available and it's possible for more data to be sent. Once a message is
-    /// sent to the corresponding [`Sender`], then this receiver will wake up and
-    /// return that message.
+    /// sent to the corresponding [`Sender`] (or [`SyncSender`]), then this


https://travis-ci.org/rust-lang/rust/jobs/225404572

this line causes a failure on travis.

this is considered a markdown link:

[foo] (bar.html)

for the same reason this is:

[`Sender`] (or [`SyncSender`])

to get around this, do something like this:

[`Sender`][`Sender`] (or [`SyncSender`])

Hmm, how did Travis not pick it up last time. 😕 Or the tests I ran, for that matter.

frewsxcv · 2017-04-25T00:57:41Z

@bors r-

projektir · 2017-04-27T07:10:44Z

...I want to say it should be good to merge now?

steveklabnik · 2017-04-27T09:45:55Z

Lookin' good!

@bors: r+ rollup

bors · 2017-04-27T09:45:56Z

📌 Commit c59b188 has been approved by steveklabnik

Adding links and examples for various mspc pages rust-lang#29377 Adding links and copying examples for the various Iterators; adding some extra stuff to `Sender`/`SyncSender`/`Receiver`.

Rollup of 7 pull requests - Successful merges: #41438, #41523, #41526, #41546, #41556, #41572, #41578 - Failed merges:

rust-highfive assigned brson Apr 21, 2017

shepmaster added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Apr 21, 2017

chordowl suggested changes Apr 21, 2017

View reviewed changes

chordowl reviewed Apr 21, 2017

View reviewed changes

chordowl approved these changes Apr 22, 2017

View reviewed changes

frewsxcv mentioned this pull request Apr 24, 2017

Rollup of 7 pull requests #41513

Closed

frewsxcv mentioned this pull request Apr 24, 2017

Rollup of 6 pull requests #41516

Closed

frewsxcv reviewed Apr 25, 2017

View reviewed changes

arielb1 added the T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. label Apr 25, 2017

Adding links and examples for various mspc pages #29377

c59b188

arielb1 mentioned this pull request Apr 27, 2017

Rollup of 10 pull requests #41579

Closed

frewsxcv mentioned this pull request Apr 27, 2017

Rollup of 8 pull requests #41585

Closed

frewsxcv mentioned this pull request Apr 27, 2017

Rollup of 7 pull requests #41591

Merged

bors added a commit that referenced this pull request Apr 28, 2017

Auto merge of #41591 - frewsxcv:rollup, r=frewsxcv

70baf4f

Rollup of 7 pull requests - Successful merges: #41438, #41523, #41526, #41546, #41556, #41572, #41578 - Failed merges:

bors merged commit c59b188 into rust-lang:master Apr 28, 2017

projektir deleted the mpsc_docs branch April 28, 2017 21:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding links and examples for various mspc pages #29377 #41438

Adding links and examples for various mspc pages #29377 #41438

projektir commented Apr 21, 2017

rust-highfive commented Apr 21, 2017

shepmaster commented Apr 21, 2017

alexcrichton commented Apr 21, 2017

chordowl left a comment •

edited

Loading

chordowl Apr 21, 2017

chordowl Apr 21, 2017

chordowl Apr 21, 2017

chordowl Apr 21, 2017

projektir commented Apr 22, 2017

chordowl left a comment

alexcrichton commented Apr 24, 2017

bors commented Apr 24, 2017

frewsxcv Apr 25, 2017

projektir Apr 25, 2017

frewsxcv commented Apr 25, 2017

projektir commented Apr 27, 2017

steveklabnik commented Apr 27, 2017

bors commented Apr 27, 2017

Adding links and examples for various mspc pages #29377 #41438

Adding links and examples for various mspc pages #29377 #41438

Conversation

projektir commented Apr 21, 2017

rust-highfive commented Apr 21, 2017

shepmaster commented Apr 21, 2017

alexcrichton commented Apr 21, 2017

chordowl left a comment • edited Loading

Choose a reason for hiding this comment

chordowl Apr 21, 2017

Choose a reason for hiding this comment

chordowl Apr 21, 2017

Choose a reason for hiding this comment

chordowl Apr 21, 2017

Choose a reason for hiding this comment

chordowl Apr 21, 2017

Choose a reason for hiding this comment

projektir commented Apr 22, 2017

chordowl left a comment

Choose a reason for hiding this comment

alexcrichton commented Apr 24, 2017

bors commented Apr 24, 2017

frewsxcv Apr 25, 2017

Choose a reason for hiding this comment

projektir Apr 25, 2017

Choose a reason for hiding this comment

frewsxcv commented Apr 25, 2017

projektir commented Apr 27, 2017

steveklabnik commented Apr 27, 2017

bors commented Apr 27, 2017

chordowl left a comment •

edited

Loading