The Wayback Machine - https://web.archive.org/web/20210121015144/https://github.com/RustAudio/vst-rs/issues/116
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

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

Comments

@crsaracco
Copy link
Member

@crsaracco crsaracco commented Jan 2, 2020

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 join this conversation on GitHub. Already have an account? Sign in to comment
1 participant
You can’t perform that action at this time.