Skip to content

Commit 9a7f63e

Browse files
committed
clippy: allow long first paragraphs in select... fn doc comments
1 parent 78df513 commit 9a7f63e

File tree

3 files changed

+4
-0
lines changed

3 files changed

+4
-0
lines changed

futures-util/src/async_await/select_mod.rs

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
macro_rules! document_select_macro {
44
// This branch is required for `futures 0.3.1`, from before select_biased was introduced
55
($select:item) => {
6+
#[allow(clippy::too_long_first_doc_paragraph)]
67
/// Polls multiple futures and streams simultaneously, executing the branch
78
/// for the future that finishes first. If multiple futures are ready,
89
/// one will be pseudo-randomly selected at runtime. Futures directly
@@ -153,6 +154,7 @@ macro_rules! document_select_macro {
153154
($select:item $select_biased:item) => {
154155
document_select_macro!($select);
155156

157+
#[allow(clippy::too_long_first_doc_paragraph)]
156158
/// Polls multiple futures and streams simultaneously, executing the branch
157159
/// for the future that finishes first. Unlike [`select!`], if multiple futures are ready,
158160
/// one will be selected in order of declaration. Futures directly

futures-util/src/async_await/stream_select_mod.rs

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
#[doc(hidden)]
44
pub use futures_macro::stream_select_internal;
55

6+
#[allow(clippy::too_long_first_doc_paragraph)]
67
/// Combines several streams, all producing the same `Item` type, into one stream.
78
/// This is similar to `select_all` but does not require the streams to all be the same type.
89
/// It also keeps the streams inline, and does not require `Box<dyn Stream>`s to be allocated.

futures-util/src/stream/select_with_strategy.rs

+1
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ pin_project! {
7575
}
7676
}
7777

78+
#[allow(clippy::too_long_first_doc_paragraph)]
7879
/// This function will attempt to pull items from both streams. You provide a
7980
/// closure to tell [`SelectWithStrategy`] which stream to poll. The closure can
8081
/// store state on `SelectWithStrategy` to which it will receive a `&mut` on every

0 commit comments

Comments
 (0)