Skip to content

Commit ca04ac6

Browse files
authored
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 cd1f29a commit ca04ac6

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
@@ -404,9 +404,9 @@ pub trait StreamExt: Stream {
404404
/// use futures::stream::{self, StreamExt};
405405
///
406406
/// let stream = stream::iter(1..=10);
407-
/// let evens = stream.filter(|x| future::ready(x % 2 == 0));
407+
/// let events = stream.filter(|x| future::ready(x % 2 == 0));
408408
///
409-
/// assert_eq!(vec![2, 4, 6, 8, 10], evens.collect::<Vec<_>>().await);
409+
/// assert_eq!(vec![2, 4, 6, 8, 10], events.collect::<Vec<_>>().await);
410410
/// # });
411411
/// ```
412412
fn filter<Fut, F>(self, f: F) -> Filter<Self, Fut, F>
@@ -436,11 +436,11 @@ pub trait StreamExt: Stream {
436436
/// use futures::stream::{self, StreamExt};
437437
///
438438
/// let stream = stream::iter(1..=10);
439-
/// let evens = stream.filter_map(|x| async move {
439+
/// let events = stream.filter_map(|x| async move {
440440
/// if x % 2 == 0 { Some(x + 1) } else { None }
441441
/// });
442442
///
443-
/// assert_eq!(vec![3, 5, 7, 9, 11], evens.collect::<Vec<_>>().await);
443+
/// assert_eq!(vec![3, 5, 7, 9, 11], events.collect::<Vec<_>>().await);
444444
/// # });
445445
/// ```
446446
fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F>

0 commit comments

Comments
 (0)