chore: recommend to use core lib's ready macro (#2925)

Signed-off-by: tison <wander4096@gmail.com>
rust-lang · Feb 17, 2025 · c9b796c · c9b796c
1 parent 048995a
commit c9b796c
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/futures-core/src/task/poll.rs b/futures-core/src/task/poll.rs
@@ -1,6 +1,9 @@
-/// Extracts the successful type of a `Poll<T>`.
+/// Extracts the successful type of `Poll<T>`.
 ///
 /// This macro bakes in propagation of `Pending` signals by returning early.
+///
+/// **Note:** Since Rust 1.64, this macro is soft-deprecated in favor of
+/// [`ready!`](core::task::ready) macro in the standard library.
 #[macro_export]
 macro_rules! ready {
     ($e:expr $(,)?) => {