Skip to content

Commit f076528

Browse files
authored
Add a disclaimer saying this is a basic executor (smol-rs#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 <dev@notgull.net>
1 parent c7fd967 commit f076528

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ https://docs.rs/async-executor)
1111

1212
Async executors.
1313

14+
This crate provides two reference executors that trade performance for
15+
functionality. They should be considered reference executors that are "good
16+
enough" for most use cases. For more specialized use cases, consider writing
17+
your own executor on top of [`async-task`].
18+
19+
[`async-task`]: https://crates.io/crates/async-task
20+
1421
## Examples
1522

1623
```rust

src/lib.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
//! Async executors.
22
//!
3+
//! This crate provides two reference executors that trade performance for
4+
//! functionality. They should be considered reference executors that are "good
5+
//! enough" for most use cases. For more specialized use cases, consider writing
6+
//! your own executor on top of [`async-task`].
7+
//!
8+
//! [`async-task`]: https://crates.io/crates/async-task
9+
//!
310
//! # Examples
411
//!
512
//! ```

0 commit comments

Comments
 (0)