Skip to content

Document all unsafe blocks. #562

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

Open
reitermarkus opened this issue Apr 26, 2025 · 0 comments
Open

Document all unsafe blocks. #562

reitermarkus opened this issue Apr 26, 2025 · 0 comments
Milestone

Comments

@reitermarkus
Copy link
Member

reitermarkus commented Apr 26, 2025

All unsafe blocks should be documented with a SAFETY comment and be scoped as closely as possible.

After all are documented, the clippy::undocumented_unsafe_blocks lint should be enabled.

Also, the unsafe_op_in_unsafe_fn lint should be enabled (default in edition 2024), so that unsafe blocks in unsafe functions are also documented.

@reitermarkus reitermarkus added this to the v1.0.0 milestone Apr 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant