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

Write usage examples #76

Closed
dtolnay opened this issue Apr 4, 2017 · 4 comments
Closed

Write usage examples #76

dtolnay opened this issue Apr 4, 2017 · 4 comments
Labels
easy help wanted

Comments

@dtolnay
Copy link
Member

dtolnay commented Apr 4, 2017

The crate-level documentation at https://docs.rs/flate2 as well the documentation for the modules / types / traits / methods should contain examples. Currently the only two pieces of example code are in the readme.
@dtolnay
Copy link
Member Author

dtolnay commented Apr 4, 2017

Remember to use ?, not try! or unwrap(), for the examples.

@dtolnay dtolnay mentioned this issue Apr 4, 2017
Closed
15 tasks
@alexcrichton alexcrichton mentioned this issue Apr 19, 2017
Closed
@AndyGauge AndyGauge mentioned this issue May 9, 2017
Merged
@AndyGauge
Copy link
Contributor

Added deflate examples #114

@brson
Copy link

brson commented May 24, 2017

Thanks @AndyGauge !

@AndyGauge AndyGauge mentioned this issue May 26, 2017
Merged
@alexcrichton
Copy link
Member

Finished through multiple PRs by @AndyGauge, thanks so much again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
easy help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@alexcrichton @brson @dtolnay @AndyGauge