From 738fd466188572d29efb121503cb0a07ee5d2370 Mon Sep 17 00:00:00 2001 From: Andrew Silver Date: Thu, 5 Nov 2020 08:12:38 +1100 Subject: [PATCH 1/2] Updated docs to correct version + mention tokio03 feature flag, updated CHANGELOG.md to add diff for 1.6.5...1.7.0 --- CHANGELOG.md | 3 ++- src/lib.rs | 21 +++++++++++++++------ 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 80f2ab28..c0cd2f83 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -798,7 +798,8 @@ task::blocking(async { - Initial beta release -[Unreleased]: https://github.com/async-rs/async-std/compare/v1.6.5...HEAD +[Unreleased]: https://github.com/async-rs/async-std/compare/v1.7.0...HEAD +[1.7.0]: https://github.com/async-rs/async-std/compare/v1.6.5...1.7.0 [1.6.5]: https://github.com/async-rs/async-std/compare/v1.6.4...v1.6.5 [1.6.4]: https://github.com/async-rs/async-std/compare/v1.6.3...v1.6.4 [1.6.3]: https://github.com/async-rs/async-std/compare/v1.6.2...v1.6.3 diff --git a/src/lib.rs b/src/lib.rs index bd3afbdf..47aac45d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -197,7 +197,7 @@ //! //! ```toml //! [dependencies.async-std] -//! version = "1.6.5" +//! version = "1.7.0" //! features = ["unstable"] //! ``` //! @@ -210,25 +210,34 @@ //! //! ```toml //! [dependencies.async-std] -//! version = "1.6.5" +//! version = "1.7.0" //! features = ["attributes"] //! ``` //! -//! Compatibility with the `tokio` runtime is possible using the `tokio02` +//! Compatibility with the `tokio` 0.2 runtime is possible using the `tokio02` //! Cargo feature: //! //! ```toml //! [dependencies.async-std] -//! version = "1.6.5" +//! version = "1.7.0" //! features = ["tokio02"] //! ``` //! +//! Compatibility with the `tokio` 0.3 runtime is also simultaneously possible using the `tokio03` +//! Cargo feature: +//! +//! ```toml +//! [dependencies.async-std] +//! version = "1.7.0" +//! features = ["tokio03"] +//! ``` +//! //! Additionally it's possible to only use the core traits and combinators by //! only enabling the `std` Cargo feature: //! //! ```toml //! [dependencies.async-std] -//! version = "1.6.5" +//! version = "1.7.0" //! default-features = false //! features = ["std"] //! ``` @@ -238,7 +247,7 @@ //! //! ```toml //! [dependencies.async-std] -//! version = "1.6.5" +//! version = "1.7.0" //! default-features = false //! features = ["alloc"] //! ``` From 7d20a4435c2e70f9407129ba259b68e82b376fe1 Mon Sep 17 00:00:00 2001 From: Andrew Silver Date: Thu, 5 Nov 2020 08:15:34 +1100 Subject: [PATCH 2/2] Fixed updated docs to match the 80 column style the rest of the docs use --- src/lib.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 47aac45d..6f97bdca 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -223,8 +223,8 @@ //! features = ["tokio02"] //! ``` //! -//! Compatibility with the `tokio` 0.3 runtime is also simultaneously possible using the `tokio03` -//! Cargo feature: +//! Compatibility with the `tokio` 0.3 runtime is also simultaneously possible +//! using the `tokio03` Cargo feature: //! //! ```toml //! [dependencies.async-std]