From 252bbddbd1a354308d12a3e6f071598a05084602 Mon Sep 17 00:00:00 2001 From: Michael J Ward Date: Sat, 5 Oct 2019 11:37:59 -0500 Subject: [PATCH 1/4] Fixes feature flag used in generating the docs in the README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 978e1c0e3..ea6b8187c 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,7 @@ git clone git@github.com:async-rs/async-std.git && cd async-std Generate docs: ``` -cargo doc --features docs.rs --open +cargo doc --features docs --open ``` Check out the [examples](examples). To run an example: From cf6277bcdc2ec69224bd84231279ec124c0f1204 Mon Sep 17 00:00:00 2001 From: Michael J Ward Date: Sun, 6 Oct 2019 09:24:29 -0500 Subject: [PATCH 2/4] Adds +nightly to cargo commands in README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ea6b8187c..ae129aa16 100644 --- a/README.md +++ b/README.md @@ -111,13 +111,13 @@ git clone git@github.com:async-rs/async-std.git && cd async-std Generate docs: ``` -cargo doc --features docs --open +cargo +nightly doc --features docs --open ``` Check out the [examples](examples). To run an example: ``` -cargo run --example hello-world +cargo +nightly run --example hello-world ``` ## Contributing From 0d521cb77cf0e9aaf0b2483cb4ca603ed0d547a7 Mon Sep 17 00:00:00 2001 From: Michael J Ward Date: Sun, 6 Oct 2019 09:45:29 -0500 Subject: [PATCH 3/4] Removes unstable feature flag from CI doc commands Per Stjepan Glavina, this flag is superfluous because #[cfg(any(feature = "unstable", feature = "docs"))] is used everywhere in the codebase. Discussion: https://github.com/async-rs/async-std/pull/278#issuecomment-538744737 --- .github/workflows/ci.yml | 2 +- .travis.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 59f149def..2443717cb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -54,4 +54,4 @@ jobs: run: cargo fmt --all -- --check - name: Docs - run: cargo doc --features docs,unstable + run: cargo doc --features docs diff --git a/.travis.yml b/.travis.yml index 0249f8ede..bb3c836fa 100644 --- a/.travis.yml +++ b/.travis.yml @@ -50,7 +50,7 @@ matrix: rust: nightly os: linux script: - - cargo doc --features docs,unstable + - cargo doc --features docs - name: book rust: nightly From 75b6c60c6791186b2a22cac8586eb9261f5384bb Mon Sep 17 00:00:00 2001 From: Michael J Ward Date: Sun, 6 Oct 2019 12:00:02 -0500 Subject: [PATCH 4/4] Corrects a cfg feature declaration in task/mod.rs --- src/task/mod.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/task/mod.rs b/src/task/mod.rs index 9e92f35dd..15eb7b1a1 100644 --- a/src/task/mod.rs +++ b/src/task/mod.rs @@ -25,7 +25,7 @@ #[doc(inline)] pub use std::task::{Context, Poll, Waker}; -#[cfg(feature = "unstable")] +#[cfg(any(feature = "unstable", feature = "docs"))] #[cfg_attr(feature = "docs", doc(cfg(unstable)))] #[doc(inline)] pub use async_macros::ready;