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

Remove "SAFETY:" tag on comments that are not related to unsafe blocks #6724

Closed
DaniPopes opened this issue Feb 21, 2024 · 1 comment
Closed
Labels
A-meta Changes in the contributor workflow and planning C-docs An addition or correction to our documentation D-good-first-issue Nice and easy! A great choice to get started

Comments

@DaniPopes
Copy link
Member

Describe the feature

The // SAFETY: comment tag is used above unsafe blocks and impls to explain the need of its usage or why it's safe.

This is not always the case in this code base, where it's also used above calls to unwrap()/expect("...") explaining why it won't panic, and other places which are completely unrelated to unsafe.

These should be replaced with NOTE: or removed to make it just a normal comment.

Additional context

@DaniPopes DaniPopes added C-docs An addition or correction to our documentation A-meta Changes in the contributor workflow and planning D-good-first-issue Nice and easy! A great choice to get started labels Feb 21, 2024
@TomAFrench
Copy link
Contributor

This can be closed now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-meta Changes in the contributor workflow and planning C-docs An addition or correction to our documentation D-good-first-issue Nice and easy! A great choice to get started
Projects
Archived in project
Development

No branches or pull requests

2 participants