rust-lang / futures-rs

Zero-cost asynchronous programming in Rust
https://rust-lang.github.io/futures-rs/
Apache License 2.0
5.31k stars 609 forks source link

Fix incorrect feature flag documented on join! macro #2804

Closed RAnders00 closed 4 months ago

RAnders00 commented 7 months ago

The join! and try_join! macros are behind the async-await-macro feature flag, not async-await.

taiki-e commented 7 months ago

Hmm. The current one is correct for the futures documentation, but indeed incorrect for the futures-util documentation.

https://github.com/rust-lang/futures-rs/blob/ae3297f25d4bc26e000990cc1dfd16505ae9998a/futures-util/Cargo.toml#L17-L18 https://github.com/rust-lang/futures-rs/blob/ae3297f25d4bc26e000990cc1dfd16505ae9998a/futures/Cargo.toml#L39

0.4 should fix the difference here (https://github.com/rust-lang/futures-rs/issues/2308#issuecomment-778572610, https://github.com/rust-lang/futures-rs/issues/2295), but it is not clear how we should handle this in 0.3.

taiki-e commented 4 months ago

Closing -- as said above, 0.3 requires a more complex fix and 0.4 does not need to do anything. In any case, this PR will not work as a corrective to any of these as it is.

Thanks anyway for the PR!