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.

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

Docs: Module level docs for tokio::stream #2786

Merged
merged 9 commits into from
Sep 9, 2020

Conversation

xd009642
Copy link
Contributor

The module docs for stream were a bit more minimal compared to other modules. This aims to fill in information on some common usage and use-cases where the solution may rely on other crates in the ecosystem or not be intuitive for newcomers.

@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 labels Aug 22, 2020
tokio/src/stream/mod.rs Outdated Show resolved Hide resolved
tokio/src/stream/mod.rs Outdated Show resolved Hide resolved
tokio/src/stream/mod.rs Outdated Show resolved Hide resolved
tokio/src/stream/mod.rs Outdated Show resolved Hide resolved
tokio/src/stream/mod.rs Outdated Show resolved Hide resolved
tokio/src/stream/mod.rs Outdated Show resolved Hide resolved
@Darksonn
Copy link
Contributor

This will probably need a slight change once #2714 (comment) is done.

tokio/src/stream/mod.rs Outdated Show resolved Hide resolved
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.

Can you add a link to the stream chapter in our tutorial? Then I think this is ready.

tokio/src/stream/mod.rs Outdated Show resolved Hide resolved
@Darksonn Darksonn merged commit 1550dda into tokio-rs:master Sep 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants