Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

stream: add missing "not" in filter_map docs #2511

Merged
merged 4 commits into from
May 10, 2020
Merged

stream: add missing "not" in filter_map docs #2511

merged 4 commits into from
May 10, 2020

Conversation

episage
Copy link
Contributor

@episage episage commented May 10, 2020 •
edited
Loading

Motivation

I noticed a mistake in StreamExt, method filter_map docs. It says:

... if it resolves to None then the next value will be produced.

and I think it should say

... if it resolves to None then the next value will be skipped.

Solution

I reworded the sentence.

Darksonn
Darksonn reviewed May 10, 2020
View reviewed changes
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR. I think it can be phrased a bit simpler like this?

tokio/src/stream/mod.rs Outdated Show resolved Hide resolved
@Darksonn Darksonn added A-tokio Area: The main tokio crate C-maintenance Category: PRs that clean code up or issues documenting cleanup. M-stream Module: tokio/stream T-docs Topic: documentation labels May 10, 2020
Darksonn
Darksonn approved these changes May 10, 2020
View reviewed changes
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I will merge it once CI says ok.

@episage
Copy link
Contributor Author

episage commented May 10, 2020

Ok, I added a comma too

@Darksonn Darksonn merged commit a75fe38 into tokio-rs:master May 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Darksonn Darksonn Darksonn approved these changes

@xentec xentec xentec left review comments

Assignees
No one assigned
Labels
A-tokio Area: The main tokio crate C-maintenance Category: PRs that clean code up or issues documenting cleanup. M-stream Module: tokio/stream T-docs Topic: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@episage @Darksonn @xentec