From f076528d27f318cef71c9828a34302a23afc00f1 Mon Sep 17 00:00:00 2001 From: John Nunley Date: Sat, 11 Nov 2023 08:34:46 -0800 Subject: [PATCH] Add a disclaimer saying this is a basic executor (#74) In many issues I've mentioned that the executors in this crate are just reference executors. However, this is not documented in the crate itself. This commit adds a disclaimer to the crate documentation and to README.md that these are reference executors that shouldn't be relied on for performance. Signed-off-by: John Nunley --- README.md | 7 +++++++ src/lib.rs | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/README.md b/README.md index c330bd6..a968713 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,13 @@ https://docs.rs/async-executor) Async executors. +This crate provides two reference executors that trade performance for +functionality. They should be considered reference executors that are "good +enough" for most use cases. For more specialized use cases, consider writing +your own executor on top of [`async-task`]. + +[`async-task`]: https://crates.io/crates/async-task + ## Examples ```rust diff --git a/src/lib.rs b/src/lib.rs index 79428cd..a30dc9c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,5 +1,12 @@ //! Async executors. //! +//! This crate provides two reference executors that trade performance for +//! functionality. They should be considered reference executors that are "good +//! enough" for most use cases. For more specialized use cases, consider writing +//! your own executor on top of [`async-task`]. +//! +//! [`async-task`]: https://crates.io/crates/async-task +//! //! # Examples //! //! ```