diff options
author | Oleg Nosov <olegnosov1@gmail.com> | 2020-01-24 20:31:13 +0300 |
---|---|---|
committer | Carl Lerche <me@carllerche.com> | 2020-01-24 09:31:13 -0800 |
commit | f9ddb93604a830d106475bd4c4cae436fafcc0da (patch) | |
tree | 6f200680e68b290794ef0512dcb031ef6d81c5ea /tokio/src/sync/watch.rs | |
parent | a70f7203a46d471345128832987017612d8e4585 (diff) |
docs: use third form in API docs (#2027)
Diffstat (limited to 'tokio/src/sync/watch.rs')
-rw-r--r-- | tokio/src/sync/watch.rs | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/tokio/src/sync/watch.rs b/tokio/src/sync/watch.rs index ebcad45c..3e945563 100644 --- a/tokio/src/sync/watch.rs +++ b/tokio/src/sync/watch.rs @@ -151,7 +151,7 @@ struct WatchInner { const CLOSED: usize = 1; -/// Create a new watch channel, returning the "send" and "receive" handles. +/// Creates a new watch channel, returning the "send" and "receive" handles. /// /// All values sent by [`Sender`] will become visible to the [`Receiver`] handles. /// Only the last value sent is made available to the [`Receiver`] half. All @@ -320,7 +320,7 @@ impl WatchInner { } impl<T> Sender<T> { - /// Broadcast a new value via the channel, notifying all receivers. + /// Broadcasts a new value via the channel, notifying all receivers. pub fn broadcast(&self, value: T) -> Result<(), error::SendError<T>> { let shared = match self.shared.upgrade() { Some(shared) => shared, @@ -363,7 +363,7 @@ impl<T> Sender<T> { } } -/// Notify all watchers of a change +/// Notifies all watchers of a change fn notify_all<T>(shared: &Shared<T>) { let watchers = shared.watchers.lock().unwrap(); |