Skip to content

Commit 812cc80

Browse files
committed
Add deprecation notice to the top of the library documentation
This ensures it'll show up on docs.rs, in addition to the notice currently in the README and crates.io.
1 parent 96f5646 commit 812cc80

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

src/lib.rs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,20 @@
11
#![allow(rustdoc::invalid_html_tags)]
2+
//! # `async-std` has been discontinued; use `smol` instead
3+
//!
4+
//! We created `async-std` to demonstrate the value of making a library as close to
5+
//! `std` as possible, but async. We think that demonstration was successful, and
6+
//! we hope it will influence future design and development directions of async in
7+
//! `std`. However, in the meantime, the [`smol`](https://github.com/smol-rs/smol/)
8+
//! project came about and provided a great executor and libraries for asynchronous
9+
//! use in the Rust ecosystem. We think that resources would be better spent
10+
//! consolidating around `smol`, rather than continuing to provide occasional
11+
//! maintenance of `async-std`. As such, we recommend that all users of
12+
//! `async-std`, and all libraries built on `async-std`, switch to `smol` instead.
13+
//!
14+
//! In addition to the `smol` project as a direct replacement, you may find other
15+
//! parts of the futures ecosystem useful, including `futures-concurrency`,
16+
//! `async-io`, `futures-lite`, and `async-compat`.
17+
//!
218
//! # Async version of the Rust standard library
319
//!
420
//! `async-std` is a foundation of portable Rust software, a set of minimal and battle-tested

0 commit comments

Comments
 (0)