Skip to content

Commit 9392578

Browse files
jdrouettaiki-e
authored andcommitted
Fix variable name in documentation (#2555)
A variable name was misspelled in the `filter` and `filter_map` functions documentation. This replaces `evens` by `events`.
1 parent c79b674 commit 9392578

File tree

1 file changed

+4
-4
lines changed
  • futures-util/src/stream/stream

1 file changed

+4
-4
lines changed

futures-util/src/stream/stream/mod.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -390,9 +390,9 @@ pub trait StreamExt: Stream {
390390
/// use futures::stream::{self, StreamExt};
391391
///
392392
/// let stream = stream::iter(1..=10);
393-
/// let evens = stream.filter(|x| future::ready(x % 2 == 0));
393+
/// let events = stream.filter(|x| future::ready(x % 2 == 0));
394394
///
395-
/// assert_eq!(vec![2, 4, 6, 8, 10], evens.collect::<Vec<_>>().await);
395+
/// assert_eq!(vec![2, 4, 6, 8, 10], events.collect::<Vec<_>>().await);
396396
/// # });
397397
/// ```
398398
fn filter<Fut, F>(self, f: F) -> Filter<Self, Fut, F>
@@ -422,11 +422,11 @@ pub trait StreamExt: Stream {
422422
/// use futures::stream::{self, StreamExt};
423423
///
424424
/// let stream = stream::iter(1..=10);
425-
/// let evens = stream.filter_map(|x| async move {
425+
/// let events = stream.filter_map(|x| async move {
426426
/// if x % 2 == 0 { Some(x + 1) } else { None }
427427
/// });
428428
///
429-
/// assert_eq!(vec![3, 5, 7, 9, 11], evens.collect::<Vec<_>>().await);
429+
/// assert_eq!(vec![3, 5, 7, 9, 11], events.collect::<Vec<_>>().await);
430430
/// # });
431431
/// ```
432432
fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F>

0 commit comments

Comments
 (0)