Skip to content

Commit c4ba11f

Browse files
authored
Merge pull request #535 from async-rs/docs-sender-recv
backlink channel types
2 parents 77a0419 + 31f129e commit c4ba11f

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

src/sync/channel.rs

+9-1
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,11 @@ pub fn channel<T>(cap: usize) -> (Sender<T>, Receiver<T>) {
7171

7272
/// The sending side of a channel.
7373
///
74+
/// This struct is created by the [`channel`] function. See its
75+
/// documentation for more.
76+
///
77+
/// [`channel`]: fn.channel.html
78+
///
7479
/// # Examples
7580
///
7681
/// ```
@@ -298,8 +303,11 @@ impl<T> fmt::Debug for Sender<T> {
298303

299304
/// The receiving side of a channel.
300305
///
301-
/// This type implements the [`Stream`] trait, which means it can act as an asynchronous iterator.
306+
/// This type receives messages by calling `recv`. But it also implements the [`Stream`] trait,
307+
/// which means it can act as an asynchronous iterator. This struct is created by the [`channel`]
308+
/// function. See its documentation for more.
302309
///
310+
/// [`channel`]: fn.channel.html
303311
/// [`Stream`]: ../stream/trait.Stream.html
304312
///
305313
/// # Examples

0 commit comments

Comments
 (0)