Skip to content

Commit

Permalink
Fix doc comments of stream::pending
Browse files Browse the repository at this point in the history
  • Loading branch information
Markus Westerlind authored and cramertj committed Jun 27, 2019
1 parent d48ed85 commit 6f16a1b
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions futures-util/src/stream/pending.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ use core::pin::Pin;
use futures_core::{Stream, Poll};
use futures_core::task;

/// A stream which never returns any elements.
///
/// This stream can be created with the `stream::pending` function.
/// Stream for the [`pending()`] function.
#[derive(Debug)]
#[must_use = "streams do nothing unless polled"]
pub struct Pending<T> {
Expand Down

0 comments on commit 6f16a1b

Please sign in to comment.