Add links and some examples to std::sync::mpsc docs #40981

Technius · 2017-04-01T00:23:25Z

Addresses part of #29377
r? @steveklabnik

I took a stab at adding links to the std::sync::mpsc docs, and I also wrote a few examples.

Edit: Whoops, typed in ?r instead of r?.

This change adds links to to `Receiver`, `Iter`, `TryIter`, `IntoIter`, `Sender`, `SyncSender`, `SendError`, `RecvError`, `TryRecvError`, `RecvTimeoutError`, `TrySendError`, `Sender::send`, `SyncSender::send`, `SyncSender::try_send`, `Receiver::recv`, `Receiver::recv_timeout`, `Receiver::iter`, and `Receiver::try_iter`. Examples added to `Receiver`, `Sender`, `Receiver::iter`.

rust-highfive · 2017-04-01T00:23:38Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @alexcrichton (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.

alexcrichton · 2017-04-01T01:04:59Z

r? @steveklabnik

frewsxcv · 2017-04-01T04:49:59Z

Travis found some errors

https://gist.github.com/frewsxcv/d968eb5970f2d7530fc6c86c723c95a5

steveklabnik

Thank you so much! This is great, I just have a few minor style nits. We don't use ()s for function names, and some extra whitespace will make these examples more readable. Thank you!

steveklabnik · 2017-04-03T15:48:03Z

src/libstd/sync/mpsc/mod.rs

 //! senders are clone-able (multi-producer) such that many threads can send
 //! simultaneously to one receiver (single-consumer).
 //!
 //! These channels come in two flavors:
 //!
-//! 1. An asynchronous, infinitely buffered channel. The `channel()` function
+//! 1. An asynchronous, infinitely buffered channel. The [`channel()`] function


I know you're adapting existing text here, but the style is to drop the ()s. Would you mind doing that as well please?

steveklabnik · 2017-04-03T15:48:08Z

src/libstd/sync/mpsc/mod.rs

-//! 2. A synchronous, bounded channel. The `sync_channel()` function will return
-//!    a `(SyncSender, Receiver)` tuple where the storage for pending messages
-//!    is a pre-allocated buffer of a fixed size. All sends will be
+//! 2. A synchronous, bounded channel. The [`sync_channel()`] function will


steveklabnik · 2017-04-03T15:48:15Z

src/libstd/sync/mpsc/mod.rs

+//! [`Receiver`]: ../../../std/sync/mpsc/struct.Receiver.html
+//! [`send`]: ../../../std/sync/mpsc/struct.Sender.html#method.send
+//! [`channel()`]: ../../../std/sync/mpsc/fn.channel.html
+//! [`sync_channel()`]: ../../../std/sync/mpsc/fn.sync_channel.html


and both of these lines to match

steveklabnik · 2017-04-03T15:48:22Z

src/libstd/sync/mpsc/mod.rs

-//! continue to `unwrap()` the results returned from this module, instigating a
-//! propagation of failure among threads if one unexpectedly dies.
+//! continue to make progress, so [`Err`] will be returned. Many applications
+//! will continue to [`unwrap()`] the results returned from this module,


steveklabnik · 2017-04-03T15:48:25Z

src/libstd/sync/mpsc/mod.rs

+//!
+//! [`Result`]: ../../../std/result/enum.Result.html
+//! [`Err`]: ../../../std/result/enum.Result.html#variant.Err
+//! [`unwrap()`]: ../../../std/result/enum.Result.html#method.unwrap


steveklabnik · 2017-04-03T15:49:15Z

src/libstd/sync/mpsc/mod.rs

+/// thread::spawn(move || {
+///     sender.send(1).unwrap();
+/// });
+/// // Second thread owns sender2


and one above here

steveklabnik · 2017-04-03T15:49:20Z

src/libstd/sync/mpsc/mod.rs

+/// thread::spawn(move || {
+///     sender2.send(2).unwrap();
+/// });
+/// let msg = receiver.recv().unwrap();


and one above here

steveklabnik · 2017-04-03T15:49:26Z

src/libstd/sync/mpsc/mod.rs

+/// });
+/// let msg = receiver.recv().unwrap();
+/// let msg2 = receiver.recv().unwrap();
+/// assert_eq!(3, msg + msg2);


and one above here, please!

steveklabnik · 2017-04-03T15:49:47Z

src/libstd/sync/mpsc/mod.rs

+    /// ```rust
+    /// use std::sync::mpsc::channel;
+    /// use std::thread;
+    /// let (send, recv) = channel();


one blank line above and below this line, please!

steveklabnik · 2017-04-03T15:49:51Z

src/libstd/sync/mpsc/mod.rs

+    ///     send.send(2u8).unwrap();
+    ///     send.send(3u8).unwrap();
+    /// });
+    /// for x in recv.iter() {


and one above here

steveklabnik · 2017-04-04T13:22:56Z

@bors: r+ rollup

Thanks!

bors · 2017-04-04T13:22:57Z

📌 Commit ab4f442 has been approved by steveklabnik

@steveklabnik

Add links and some examples to std::sync::mpsc docs Addresses part of rust-lang#29377 r? @steveklabnik I took a stab at adding links to the `std::sync::mpsc` docs, and I also wrote a few examples. Edit: Whoops, typed in `?r` instead of `r?`.

@steveklabnik

Add links and some examples to std::sync::mpsc docs Addresses part of rust-lang#29377 r? @steveklabnik I took a stab at adding links to the `std::sync::mpsc` docs, and I also wrote a few examples. Edit: Whoops, typed in `?r` instead of `r?`.

@steveklabnik

Add links and some examples to std::sync::mpsc docs Addresses part of rust-lang#29377 r? @steveklabnik I took a stab at adding links to the `std::sync::mpsc` docs, and I also wrote a few examples. Edit: Whoops, typed in `?r` instead of `r?`.

@steveklabnik

Add links and some examples to std::sync::mpsc docs Addresses part of rust-lang#29377 r? @steveklabnik I took a stab at adding links to the `std::sync::mpsc` docs, and I also wrote a few examples. Edit: Whoops, typed in `?r` instead of `r?`.

Rollup of 19 pull requests - Successful merges: #40608, #40870, #40949, #40977, #40981, #40988, #40992, #40997, #40999, #41007, #41014, #41019, #41035, #41043, #41049, #41062, #41066, #41076, #41085 - Failed merges:

Technius added 2 commits March 30, 2017 23:28

Add links to std::sync::mpsc docs rust-lang#29377

5a6ebdf

rust-highfive assigned alexcrichton Apr 1, 2017

Technius changed the title ~~Add links to std::sync::mpsc docs~~ Add links and some examples to std::sync::mpsc docs Apr 1, 2017

rust-highfive assigned steveklabnik and unassigned alexcrichton Apr 1, 2017

Fix broken links to std::iter::Iterator::next

ae8ba78

Fix warnings in examples

dab8e81

frewsxcv added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Apr 1, 2017

steveklabnik suggested changes Apr 3, 2017

View reviewed changes

Fix styling issues

ab4f442

steveklabnik approved these changes Apr 4, 2017

View reviewed changes

frewsxcv mentioned this pull request Apr 4, 2017

Rollup of 18 pull requests #41067

Closed

frewsxcv mentioned this pull request Apr 4, 2017

Rollup of 17 pull requests #41068

Closed

frewsxcv mentioned this pull request Apr 4, 2017

Rollup of 16 pull requests #41070

Closed

frewsxcv mentioned this pull request Apr 5, 2017

Rollup of 19 pull requests #41086

Merged

bors merged commit ab4f442 into rust-lang:master Apr 5, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add links and some examples to std::sync::mpsc docs #40981

Add links and some examples to std::sync::mpsc docs #40981

Technius commented Apr 1, 2017 •

edited

Loading

rust-highfive commented Apr 1, 2017

alexcrichton commented Apr 1, 2017

frewsxcv commented Apr 1, 2017

steveklabnik left a comment

steveklabnik Apr 3, 2017

steveklabnik Apr 3, 2017

steveklabnik Apr 3, 2017

steveklabnik Apr 3, 2017

steveklabnik Apr 3, 2017

steveklabnik Apr 3, 2017

steveklabnik Apr 3, 2017

steveklabnik Apr 3, 2017

steveklabnik Apr 3, 2017

steveklabnik Apr 3, 2017

steveklabnik commented Apr 4, 2017

bors commented Apr 4, 2017

Add links and some examples to std::sync::mpsc docs #40981

Add links and some examples to std::sync::mpsc docs #40981

Conversation

Technius commented Apr 1, 2017 • edited Loading

rust-highfive commented Apr 1, 2017

alexcrichton commented Apr 1, 2017

frewsxcv commented Apr 1, 2017

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

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

steveklabnik commented Apr 4, 2017

bors commented Apr 4, 2017

Technius commented Apr 1, 2017 •

edited

Loading