Skip to content

Commit a956404

Browse files
authored
Refer to Poll::Pending in ReadMe. (#45)
* Refer to `Poll::Pending` in ReadMe. * Remove parentheses.
1 parent 2fe7f68 commit a956404

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ with the `async` / `await` model.
2121

2222
The [`WouldBlock`](enum.Error.html) error variant signals that the operation
2323
can't be completed *right now* and would need to block to complete.
24-
[`WouldBlock`](enum.Error.html) is a special error in the sense that's not
24+
[`WouldBlock`](enum.Error.html) is a special error in the sense that it's not
2525
*fatal*; the operation can still be completed by retrying again later.
2626

2727
[`nb::Result`](type.Result.html) is based on the API of
@@ -32,12 +32,10 @@ which has a `WouldBlock` variant in its
3232
We can map [`WouldBlock`](enum.Error.html) to different blocking and
3333
non-blocking models:
3434

35-
- In blocking mode: [`WouldBlock`](enum.Error.html) means try again right
36-
now (i.e. busy wait)
37-
- In `futures` mode: [`WouldBlock`](enum.Error.html) means
38-
[`Async::NotReady`](https://docs.rs/futures)
39-
- In `await` mode: [`WouldBlock`](enum.Error.html) means `yield`
40-
(suspend the generator)
35+
- In blocking mode, [`WouldBlock`](enum.Error.html) means try again right
36+
now, i.e. busy waiting.
37+
- In `async` mode, [`WouldBlock`](enum.Error.html) means
38+
[`Poll::Pending`](https://doc.rust-lang.org/core/task/enum.Poll.html#variant.Pending).
4139

4240

4341
## Minimum Supported Rust Version (MSRV)

0 commit comments

Comments
 (0)