Put panic and error docs in "Panics" and "Errors" sections #72

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

Comments

Projects
None yet
1 participant
@brson
Contributor

brson commented Mar 4, 2017

Write now information about panic and error conditions is written inline with the main text. Per conventions they should be in sections titled "Panics" and "Errors".

@brson brson referenced this issue Mar 4, 2017

Closed

Library evaluation tracking issue #76

7 of 7 tasks complete

brson added a commit to brson/byteorder that referenced this issue Mar 4, 2017

@brson

This comment has been minimized.

Show comment
Hide comment
@brson

brson Mar 4, 2017

Contributor

I didn't see any Result types on my pass through the file. Not sure why I called out "Errors" specifically in the op.

Contributor

brson commented Mar 4, 2017

I didn't see any Result types on my pass through the file. Not sure why I called out "Errors" specifically in the op.

@brson

This comment has been minimized.

Show comment
Hide comment
@brson

brson Mar 4, 2017

Contributor

Oh, that's because I didn't read 'new.rs'...

Contributor

brson commented Mar 4, 2017

Oh, that's because I didn't read 'new.rs'...

brson added a commit to brson/byteorder that referenced this issue Mar 4, 2017

brson added a commit to brson/byteorder that referenced this issue Mar 4, 2017

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment