Skip to content

/api-guidelines

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

Combined guideline about documenting errors, panics, safety #133

Closed
dtolnay opened this Issue Oct 28, 2017 · 1 comment

Comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
1 participant
@dtolnay
@dtolnay
Copy link
Member

dtolnay commented Oct 28, 2017

Currently there are separate guidelines for how to document errors and how to document panics. Let's combine these and extend it to cover documentation of safety in unsafe functions.

@dtolnay dtolnay referenced this issue Oct 28, 2017

Closed

Unsafe code considerations #20

@dtolnay

This comment has been minimized.

Sign in to view
Copy link
Member Author

dtolnay commented Oct 29, 2017

Combined in ca73710 and added safety in e72e082.

@dtolnay dtolnay closed this Oct 29, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.