LocalWaker docs: Make long-ago omitted but probably intended changes · patricklam/verify-rust-std@971aa37 (original) (raw)

Original file line number Diff line number Diff line change
@@ -786,7 +786,7 @@ impl LocalWaker {
786 786 Self { waker }
787 787 }
788 788
789 -/// Creates a new `LocalWaker` that does nothing when `wake` is called.
789 +/// Returns a reference to a `LocalWaker` that does nothing when used.
790 790 ///
791 791 // Note! Much of the documentation for this method is duplicated
792 792 // in the docs for `Waker::noop`.
@@ -796,6 +796,8 @@ impl LocalWaker {
796 796 /// some futures, but are not expecting those futures to wake the waker or
797 797 /// do not need to do anything specific if it happens.
798 798 ///
799 + /// If an owned `LocalWaker` is needed, `clone()` this one.
800 + ///
799 801 /// # Examples
800 802 ///
801 803 /// ```