Enable clippy::undocumented_unsafe_blocks warning across the workspace
#10646
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…AFETY comment higher up which applies to this unsafe block as well
… comment anyway?)
… are but I'm not 100% sure
…_render` to be sure (or give more detail), also reduced the unsafe block to make it clear what function call is unsafe
…ce lints and ignored it in mikktspace
…e it is now workspace-wide
alice-i-cecile
added
A-Build-System
alice-i-cecile
approved these changes
Nov 20, 2023
killercup
approved these changes
Nov 20, 2023
alice-i-cecile
added
the
S-Ready-For-Final-Review
github-merge-queue
bot
removed this pull request from the merge queue due to a conflict with the base branch
rdrpenguin04
pushed a commit
to rdrpenguin04/bevy
that referenced
this pull request
Jan 9, 2024
…ace (bevyengine#10646) # Objective Enables warning on `clippy::undocumented_unsafe_blocks` across the workspace rather than only in `bevy_ecs`, `bevy_transform` and `bevy_utils`. This adds a little awkwardness in a few areas of code that have trivial safety or explain safety for multiple unsafe blocks with one comment however automatically prevents these comments from being missed. ## Solution This adds `undocumented_unsafe_blocks = "warn"` to the workspace `Cargo.toml` and fixes / adds a few missed safety comments. I also added `#[allow(clippy::undocumented_unsafe_blocks)]` where the safety is explained somewhere above. There are a couple of safety comments I added I'm not 100% sure about in `bevy_animation` and `bevy_render/src/view` and I'm not sure about the use of `#[allow(clippy::undocumented_unsafe_blocks)]` compared to adding comments like `// SAFETY: See above`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
Enables warning on
clippy::undocumented_unsafe_blocksacross the workspace rather than only inbevy_ecs,bevy_transformandbevy_utils. This adds a little awkwardness in a few areas of code that have trivial safety or explain safety for multiple unsafe blocks with one comment however automatically prevents these comments from being missed.Solution
This adds
undocumented_unsafe_blocks = "warn"to the workspaceCargo.tomland fixes / adds a few missed safety comments. I also added#[allow(clippy::undocumented_unsafe_blocks)]where the safety is explained somewhere above.There are a couple of safety comments I added I'm not 100% sure about in
bevy_animationandbevy_render/src/viewand I'm not sure about the use of#[allow(clippy::undocumented_unsafe_blocks)]compared to adding comments like// SAFETY: See above.