Skip to content

Commit

Permalink
Update doc-comment refering to poll() returning None
Browse files Browse the repository at this point in the history
A assume that in a previous revision the return type was `Option`?

By the way, please consider using semantic line breaks:
http://rhodesmill.org/brandon/2012/one-sentence-per-line/
  • Loading branch information
SimonSapin authored Aug 11, 2016
1 parent 9555704 commit 5acfdc5
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -322,8 +322,8 @@ pub trait Future: Send + 'static {
/// Schedule a task to be notified when this future is ready.
///
/// Throughout the lifetime of a future it may frequently be `poll`'d on to
/// test whether the value is ready yet. If `None` is returned, however, the
/// caller may then register interest via this function to get a
/// test whether the value is ready yet. If `Poll::NotReady` is returned,
/// however, the caller may then register interest via this function to get a
/// notification when the future can indeed make progress.
///
/// The `task` argument provided is the same task as provided to `poll`, and
Expand Down

0 comments on commit 5acfdc5

Please sign in to comment.