Merge pull request #278 from Michael-J-Ward/fix-readme

Fixes feature flag used in generating the docs in the README

Author: yoshuawuyts

.github/workflows/ci.yml

@@ -64,4 +64,4 @@ jobs:
       run: cargo fmt --all -- --check
 
     - name: Docs
-      run: cargo doc --features docs,unstable
+      run: cargo doc --features docs

.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

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.rs --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

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;