Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs for Waker::noop and LocalWaker::noop #128064

Merged
merged 3 commits into from
Aug 16, 2024

Commits on Jul 22, 2024

  1. Configuration menu
    Copy the full SHA
    b18c7d8 View commit details
    Browse the repository at this point in the history
  2. LocalWaker docs: Make long-ago omitted but probably intended changes

    In 6f8a944, titled
    
      Change return type of unstable `Waker::noop()` from `Waker` to `&Waker`.
    
    the summary line for Waker was changed:
    
      -    /// Creates a new `Waker` that does nothing when `wake` is called.
      +    /// Returns a reference to a `Waker` that does nothing when used.
    
    and the sentence about clone was added.
    
    LocalWaker's docs were not changed, even though the types were, but
    there is no explanation for why not.  It seems like it was simply a
    slip induced by the clone-and-hack.
    ijackson committed Jul 22, 2024
    Configuration menu
    Copy the full SHA
    c404406 View commit details
    Browse the repository at this point in the history

Commits on Aug 15, 2024

  1. Add cautionary paragraph about noop wakers.

    Based on a suggestion from @kpreid, with some further editing.
    ijackson committed Aug 15, 2024
    Configuration menu
    Copy the full SHA
    9a95573 View commit details
    Browse the repository at this point in the history