Docs for Waker and LocalWaker: Add cross-refs in comment · patricklam/verify-rust-std@c4fdac9 (original) (raw)

`@@ -531,6 +531,10 @@ impl Waker {

531

532

`` /// Returns a reference to a Waker that does nothing when used.

533

`///

534

// Note! Much of the documentation for this method is duplicated

535

`` +

// in the docs for LocalWaker::noop.

536

// If you edit it, consider editing the other copy too.

537

534

538

`` /// This is mostly useful for writing tests that need a [Context] to poll

535

539

`/// some futures, but are not expecting those futures to wake the waker or

536

540

`/// do not need to do anything specific if it happens.

`@@ -784,6 +788,10 @@ impl LocalWaker {

784

788

785

789

`` /// Creates a new LocalWaker that does nothing when wake is called.

786

790

`///

791

// Note! Much of the documentation for this method is duplicated

792

`` +

// in the docs for Waker::noop.

793

// If you edit it, consider editing the other copy too.

794

787

795

`` /// This is mostly useful for writing tests that need a [Context] to poll

788

796

`/// some futures, but are not expecting those futures to wake the waker or

789

797

`/// do not need to do anything specific if it happens.