2
0
Fork 1
mirror of https://github.com/async-rs/async-std.git synced 2025-01-16 10:49:55 +00:00

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

Fixes feature flag used in generating the docs in the README
This commit is contained in:
Yoshua Wuyts 2019-10-07 15:41:04 +02:00 committed by GitHub
commit 46ffe6ab63
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 5 additions and 5 deletions

View file

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

View file

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

View file

@ -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

View file

@ -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;