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

FromStream module-level documentation #276

Closed
yoshuawuyts opened this issue Oct 5, 2019 · 1 comment
Closed

FromStream module-level documentation #276

yoshuawuyts opened this issue Oct 5, 2019 · 1 comment
Labels
documentation Improvements or additions to documentation feedback wanted Needs feedback from users good first issue Good for newcomers

Comments

@yoshuawuyts
Copy link
Contributor

Now that #271 has been merged we have all of our FromStream implementations! The final touch for this is to add module-level documentation to async_std::stream::FromStream so we can teach people about how FromStream, IntoStream and collect work together.

In practice this means porting the std::iter::FromIterator docs, and replacing it with our Stream code. The only caveat would be that IntoStream is currently not implemented on any types because of the orphan rules. Though I don't believe that should be a blocker for these set of of docs.

I'm marking this as "good first issue" because it should be relatively straight forward to implement, and is a good opportunity to contribute to async-std!

Ref #129.
@yoshuawuyts yoshuawuyts added documentation Improvements or additions to documentation feedback wanted Needs feedback from users good first issue Good for newcomers labels Oct 5, 2019
@k-nasa k-nasa mentioned this issue Oct 6, 2019
Merged
bors bot added a commit that referenced this issue Oct 6, 2019
@bors @k-nasa
Merge #281
eb04949 
281: Add FromStream documentation r=yoshuawuyts a=k-nasa

Ref: #276


Co-authored-by: k-nasa <htilcs1115@gmail.com>
@k-nasa
Copy link
Member

k-nasa commented Oct 6, 2019

The issue should close?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation feedback wanted Needs feedback from users good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@yoshuawuyts @k-nasa