Skip to content

Fixes feature flag used in generating the docs in the README #278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ jobs:
run: cargo fmt --all -- --check

- name: Docs
run: cargo doc --features docs,unstable
run: cargo doc --features docs
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ matrix:
rust: nightly
os: linux
script:
- cargo doc --features docs,unstable
- cargo doc --features docs

- name: book
rust: nightly
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/task/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down