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

Fixes feature flag used in generating the docs in the README
write-by-ref
Yoshua Wuyts 5 years ago committed by GitHub
commit 46ffe6ab63
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

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

@ -50,7 +50,7 @@ matrix:
rust: nightly rust: nightly
os: linux os: linux
script: script:
- cargo doc --features docs,unstable - cargo doc --features docs
- name: book - name: book
rust: nightly rust: nightly

@ -111,13 +111,13 @@ git clone git@github.com:async-rs/async-std.git && cd async-std
Generate docs: Generate docs:
``` ```
cargo doc --features docs.rs --open cargo +nightly doc --features docs --open
``` ```
Check out the [examples](examples). To run an example: Check out the [examples](examples). To run an example:
``` ```
cargo run --example hello-world cargo +nightly run --example hello-world
``` ```
## Contributing ## Contributing

@ -25,7 +25,7 @@
#[doc(inline)] #[doc(inline)]
pub use std::task::{Context, Poll, Waker}; pub use std::task::{Context, Poll, Waker};
#[cfg(feature = "unstable")] #[cfg(any(feature = "unstable", feature = "docs"))]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))] #[cfg_attr(feature = "docs", doc(cfg(unstable)))]
#[doc(inline)] #[doc(inline)]
pub use async_macros::ready; pub use async_macros::ready;

Loading…
Cancel
Save