Add more examples #75

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

Comments

Projects
None yet
3 participants
@brson
Contributor

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 referenced this issue Mar 4, 2017

Closed

Library evaluation tracking issue #76

7 of 7 tasks complete
@BurntSushi

This comment has been minimized.

Show comment
Hide comment
@BurntSushi

BurntSushi Mar 28, 2017

Owner

@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?

Owner

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

This comment has been minimized.

Show comment
Hide comment
@steveklabnik

steveklabnik 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.

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.

SamWhited added a commit to SamWhited/byteorder that referenced this issue Mar 28, 2017

SamWhited added a commit to SamWhited/byteorder that referenced this issue Mar 28, 2017

SamWhited added a commit to SamWhited/byteorder that referenced this issue Mar 28, 2017

BurntSushi added a commit that referenced this issue Mar 28, 2017

@BurntSushi

This comment has been minimized.

Show comment
Hide comment
@BurntSushi

BurntSushi Jul 9, 2017

Owner

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

Owner

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