From 805a31fb760873d3b973699403866ca08e8999ca Mon Sep 17 00:00:00 2001 From: Steve Klabnik Date: Fri, 13 Feb 2015 09:11:41 -0500 Subject: [PATCH] Improve documentation for `Select::new()`. Remove incorrect claim, add example, reformat and re-word. Fixes #22266 --- src/libstd/sync/mpsc/select.rs | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/src/libstd/sync/mpsc/select.rs b/src/libstd/sync/mpsc/select.rs index babae93b2d440..87b2fe8f100c3 100644 --- a/src/libstd/sync/mpsc/select.rs +++ b/src/libstd/sync/mpsc/select.rs @@ -111,11 +111,18 @@ pub trait Packet { } impl Select { - /// Creates a new selection structure. This set is initially empty and - /// `wait` will panic!() if called. + /// Creates a new selection structure. This set is initially empty. /// - /// Usage of this struct directly can sometimes be burdensome, and usage is - /// rather much easier through the `select!` macro. + /// Usage of this struct directly can sometimes be burdensome, and usage is much easier through + /// the `select!` macro. + /// + /// # Examples + /// + /// ``` + /// use std::sync::mpsc::Select; + /// + /// let select = Select::new(); + /// ``` pub fn new() -> Select { Select { head: ptr::null_mut(),