Skip to content
This repository has been archived by the owner on Mar 27, 2024. It is now read-only.

unsafe functions should have a "Safety" documentation section #116

Open
crsaracco opened this issue Jan 2, 2020 · 0 comments
Open

unsafe functions should have a "Safety" documentation section #116

crsaracco opened this issue Jan 2, 2020 · 0 comments
Labels
documentation help wanted

Comments

@crsaracco
Copy link
Member

As of PR #115 we started seeing warnings for clippy's missing_safety_doc lint. Unsafe functions should document what preconditions have to be met in order to safely call those functions.

Remove all instances of -A clippy::missing-safety-doc in .travis.yml (or whatever pipeline we're using by then) when resolved.
@crsaracco crsaracco changed the title unsafe functions should have a "Safety:" documentation section unsafe functions should have a "Safety" documentation section Jan 2, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@crsaracco @piedoom