summaryrefslogtreecommitdiffstats
path: root/tokio/src/sync/oneshot.rs
diff options
context:
space:
mode:
authorOleg Nosov <olegnosov1@gmail.com>2020-01-24 20:31:13 +0300
committerCarl Lerche <me@carllerche.com>2020-01-24 09:31:13 -0800
commitf9ddb93604a830d106475bd4c4cae436fafcc0da (patch)
tree6f200680e68b290794ef0512dcb031ef6d81c5ea /tokio/src/sync/oneshot.rs
parenta70f7203a46d471345128832987017612d8e4585 (diff)
docs: use third form in API docs (#2027)
Diffstat (limited to 'tokio/src/sync/oneshot.rs')
-rw-r--r--tokio/src/sync/oneshot.rs6
1 files changed, 3 insertions, 3 deletions
diff --git a/tokio/src/sync/oneshot.rs b/tokio/src/sync/oneshot.rs
index 5bbea381..aadb4996 100644
--- a/tokio/src/sync/oneshot.rs
+++ b/tokio/src/sync/oneshot.rs
@@ -237,7 +237,7 @@ impl<T> Sender<T> {
Pending
}
- /// Wait for the associated [`Receiver`] handle to close.
+ /// Waits for the associated [`Receiver`] handle to close.
///
/// A [`Receiver`] is closed by either calling [`close`] explicitly or the
/// [`Receiver`] value is dropped.
@@ -354,7 +354,7 @@ impl<T> Drop for Sender<T> {
}
impl<T> Receiver<T> {
- /// Prevent the associated [`Sender`] handle from sending a value.
+ /// Prevents the associated [`Sender`] handle from sending a value.
///
/// Any `send` operation which happens after calling `close` is guaranteed
/// to fail. After calling `close`, `Receiver::poll`] should be called to
@@ -610,7 +610,7 @@ impl<T> Inner<T> {
}
}
- /// Consume the value. This function does not check `state`.
+ /// Consumes the value. This function does not check `state`.
unsafe fn consume_value(&self) -> Option<T> {
self.value.with_mut(|ptr| (*ptr).take())
}