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

Add more examples #75

Closed
brson opened this issue Mar 4, 2017 · 3 comments
Closed

Add more examples #75

brson opened this issue Mar 4, 2017 · 3 comments

Comments

@brson
Copy link
Contributor

@brson brson commented Mar 4, 2017

Several types do not directly contain examples, nor do many methods. It's not clear how much example coverage we need, the policy in std though is for everything to have an example.

@brson brson mentioned this issue Mar 4, 2017
7 of 7 tasks complete
@BurntSushi
Copy link
Owner

@BurntSushi BurntSushi commented Mar 28, 2017

@steveklabnik What are your thoughts on this for a crate like byteorder? If you take a look at the ByteOrder trait, there are many methods that essentially do the same thing with differently sized integers. Are a few examples on the trait sufficient? Or do you think we should literally have an example for every method?

@steveklabnik
Copy link

@steveklabnik steveklabnik commented Mar 28, 2017

I personally prefer literally an example for every method, even if they're very similar. Users really like being able to look at the docs, copy/paste something, and get it going. IMHO that outweighs stuff looking similar.

BurntSushi added a commit that referenced this issue Mar 28, 2017
@BurntSushi
Copy link
Owner

@BurntSushi BurntSushi commented Jul 9, 2017

I think we got this covered by several PRs merged recently.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.