From dc664786c90393b454269722ead55b6fba3d8bc5 Mon Sep 17 00:00:00 2001 From: Yoshua Wuyts Date: Mon, 16 Sep 2019 14:46:56 +0200 Subject: [PATCH 1/5] document feature flags Signed-off-by: Yoshua Wuyts --- src/lib.rs | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index e5615b99..ba12b2fb 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -25,6 +25,25 @@ //! //! See [here](https://github.com/async-rs/async-std/tree/master/examples) //! for more examples. +//! +//! # Features +//! +//! `async-std` is strongly commited to following semver. This means your code +//! won't break unless _you_ decide to upgrade. +//! +//! However every now and then we come up with something that we think will +//! work _great_ for `async-std`, and we want to provide a sneak-peek so you +//! can try it out. This is what we call _"unstable"_ features. You can try out +//! the unstable features by enabling the `unstable` feature in you `Cargo.toml` +//! file: +//! +//! ```toml +//! [dependencies] +//! async-std = { version = "0.99.5", features = ["unstable"] } +//! ``` +//! +//! Just be careful when running these features, as they may change between +//! versions. #![cfg_attr(feature = "docs", feature(doc_cfg))] #![warn(missing_docs, missing_debug_implementations, rust_2018_idioms)] From 6e5f29fa5862e7fed3908ab0182c002244fb2fcb Mon Sep 17 00:00:00 2001 From: Yoshua Wuyts Date: Mon, 16 Sep 2019 14:54:19 +0200 Subject: [PATCH 2/5] document feature flags Signed-off-by: Yoshua Wuyts --- README.md | 18 ++++++++++++++++++ src/lib.rs | 19 ------------------- 2 files changed, 18 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index eb0160f4..9290757c 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,24 @@ fn main() { } ``` +## Features + +`async-std` is strongly commited to following semver. This means your code won't +break unless _you_ decide to upgrade. + +However every now and then we come up with something that we think will work +_great_ for `async-std`, and we want to provide a sneak-peek so you can try it +out. This is what we call _"unstable"_ features. You can try out the unstable +features by enabling the `unstable` feature in you `Cargo.toml` file: + +```toml +[dependencies] +async-std = { version = "0.99.5", features = ["unstable"] } +``` + +Just be careful when running these features, as they may change between +versions. + ## Take a look around Clone the repo: diff --git a/src/lib.rs b/src/lib.rs index ba12b2fb..e5615b99 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -25,25 +25,6 @@ //! //! See [here](https://github.com/async-rs/async-std/tree/master/examples) //! for more examples. -//! -//! # Features -//! -//! `async-std` is strongly commited to following semver. This means your code -//! won't break unless _you_ decide to upgrade. -//! -//! However every now and then we come up with something that we think will -//! work _great_ for `async-std`, and we want to provide a sneak-peek so you -//! can try it out. This is what we call _"unstable"_ features. You can try out -//! the unstable features by enabling the `unstable` feature in you `Cargo.toml` -//! file: -//! -//! ```toml -//! [dependencies] -//! async-std = { version = "0.99.5", features = ["unstable"] } -//! ``` -//! -//! Just be careful when running these features, as they may change between -//! versions. #![cfg_attr(feature = "docs", feature(doc_cfg))] #![warn(missing_docs, missing_debug_implementations, rust_2018_idioms)] From e6fe8da058df29bd5204bf5e9a306b20e5a7d353 Mon Sep 17 00:00:00 2001 From: Yoshua Wuyts Date: Mon, 16 Sep 2019 15:58:37 +0200 Subject: [PATCH 3/5] Update README.md Co-Authored-By: Stjepan Glavina --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9290757c..6f267c29 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ features by enabling the `unstable` feature in you `Cargo.toml` file: async-std = { version = "0.99.5", features = ["unstable"] } ``` -Just be careful when running these features, as they may change between +Just be careful when using these features, as they may change between versions. ## Take a look around From 7827410c630b80c90e597f7fb4715df088097a28 Mon Sep 17 00:00:00 2001 From: Yoshua Wuyts Date: Mon, 16 Sep 2019 15:59:41 +0200 Subject: [PATCH 4/5] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6f267c29..9342914c 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,9 @@ features by enabling the `unstable` feature in you `Cargo.toml` file: ```toml [dependencies] -async-std = { version = "0.99.5", features = ["unstable"] } +[dependencies.async-std] +version = "0.99" +features = ["unstable"] ``` Just be careful when using these features, as they may change between From 8058d637e71d74f778eb1d6a9e50578d09ef564f Mon Sep 17 00:00:00 2001 From: Yoshua Wuyts Date: Mon, 16 Sep 2019 15:59:48 +0200 Subject: [PATCH 5/5] Update README.md Co-Authored-By: Stjepan Glavina --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9342914c..1ea57243 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ break unless _you_ decide to upgrade. However every now and then we come up with something that we think will work _great_ for `async-std`, and we want to provide a sneak-peek so you can try it out. This is what we call _"unstable"_ features. You can try out the unstable -features by enabling the `unstable` feature in you `Cargo.toml` file: +features by enabling the `unstable` feature in your `Cargo.toml` file: ```toml [dependencies]