Skip to content

Commit d1260a4

Browse files
jayvdbdavidbarskyhds
authored
fix: Update incorrect tracing-futures feature docs (#2802)
Co-authored-by: David Barsky <me@davidbarsky.com> Co-authored-by: Hayden Stainsby <hds@caffeineconcepts.com>
1 parent 93c533b commit d1260a4

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

tracing-futures/src/lib.rs

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,11 @@
2424
//! This crate provides a number of feature flags that enable compatibility
2525
//! features with other crates in the asynchronous ecosystem:
2626
//!
27-
//! - `tokio`: Enables compatibility with the `tokio` crate, including
27+
//! - `tokio`: Enables compatibility with the `tokio` 0.1 crate, including
2828
//! [`Instrument`] and [`WithCollector`] implementations for
2929
//! `tokio::executor::Executor`, `tokio::runtime::Runtime`, and
30-
//! `tokio::runtime::current_thread`. Enabled by default.
30+
//! `tokio::runtime::current_thread`. This is not needed for compatibility
31+
//! with `tokio` v1.
3132
//! - `tokio-executor`: Enables compatibility with the `tokio-executor`
3233
//! crate, including [`Instrument`] and [`WithCollector`]
3334
//! implementations for types implementing `tokio_executor::Executor`.
@@ -39,8 +40,6 @@
3940
//! crate.
4041
//! - `futures-03`: Enables compatibility with version 0.3.x of the `futures`
4142
//! crate's `Spawn` and `LocalSpawn` traits.
42-
//! - `tokio-alpha`: Enables compatibility with `tokio` 0.2's alpha releases,
43-
//! including the `tokio` 0.2 `Executor` and `TypedExecutor` traits.
4443
//! - `std`: Depend on the Rust standard library.
4544
//!
4645
//! `no_std` users may disable this feature with `default-features = false`:
@@ -50,7 +49,7 @@
5049
//! tracing-futures = { version = "0.2.3", default-features = false }
5150
//! ```
5251
//!
53-
//! The `tokio`, `std-future` and `std` features are enabled by default.
52+
//! The `std-future` and `std` features are enabled by default.
5453
//!
5554
//! [`tracing`]: https://crates.io/crates/tracing
5655
//! [span]: mod@tracing::span

0 commit comments

Comments
 (0)