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

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 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
Closed
7 tasks
brson added a commit to brson/byteorder that referenced this issue Mar 4, 2017
@brson
Add 'Panics' headers. Fixes BurntSushi#72
d2bba7f
@brson
Copy link
Contributor Author

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 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
Add 'Panics' headers. Fixes BurntSushi#72
c843a5c
brson added a commit to brson/byteorder that referenced this issue Mar 4, 2017
@brson
Add 'Errors' headers. Fixes BurntSushi#72
9c3b9a6
BurntSushi pushed a commit that referenced this issue Mar 28, 2017
@brson @BurntSushi
Add 'Errors' headers. Fixes #72
ea9fbbc
@BurntSushi BurntSushi mentioned this issue Jul 9, 2017
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@brson