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

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

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

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

brson opened this issue Mar 4, 2017 · 2 comments

Comments

@brson
Copy link
Contributor

@brson 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 mentioned this issue Mar 4, 2017
7 of 7 tasks complete
brson added a commit to brson/byteorder that referenced this issue Mar 4, 2017
@brson
Copy link
Contributor Author

@brson 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
Copy link
Contributor Author

@brson 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
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.