Enable clippy::check-private-items so that missing_safety_doc will apply to private functions as well
#15161
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
…e unsafe is due to the function signature of `RawWakerVTable::new` as it requires `unsafe fn`
- `Bundles::get_storage_unchecked`: Based on the function that writes to `dynamic_component_storages` - `Bundles::get_storages_unchecked`: Based on the function that writes to `dynamic_bundle_storages` - `QueryIterationCursor::init_empty`: Duplicated from `init` - `QueryIterationCursor::peek_last`: Thanks Giooschi (also added internal unsafe blocks) - `tests::drop_ptr`: Moved safety comment out to the doc string
…etadata like `components`, `removed_components`, `bundles` etc.
alice-i-cecile
added
A-ECS
|
It looks like your PR is a breaking change, but you didn't provide a migration guide. Could you add some context on what users should update when this change get released in a new version of Bevy? |
|
I don't believe this is a breaking change? The only signature change was |
chescock
approved these changes
Sep 12, 2024
…ed for safety comments
janhohenheim
removed
the
M-Needs-Migration-Guide
alice-i-cecile
approved these changes
Sep 17, 2024
|
@13ros27 Sorry for the delay on reviewing this; please ping me once merge conflicts are resolved and I'll merge this in. |
alice-i-cecile
added
S-Ready-For-Final-Review
|
No worries, merge conflicts resolved and I've added safety comments to |
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.
Enabled
check-private-itemsinclippy.tomland then fixed the resulting errors. Most of these were simply misformatted and of the remaining:AddedRemoved unsafe from a pair of functions in#[allow(clippy::missing_safety_doc)]tobevy_utils/futureswhich are only unsafe so that they can be passed to a function which requiresunsafe fnunsafefromUnsafeWorldCell::observersas from what I can tell it is always safe likecomponents,bundlesetc. (this should be checked)Bundles::get_storage_unchecked: Based on the function that writes todynamic_component_storagesBundles::get_storages_unchecked: Based on the function that writes todynamic_bundle_storagesQueryIterationCursor::init_empty: Duplicated frominitQueryIterationCursor::peek_last: Thanks Giooschi (also added internal unsafe blocks)tests::drop_ptr: Moved safety comment out to the doc stringThis lint would also apply to
missing_errors_doc,missing_panics_docandunnecessary_safety_docif we chose to enable any of those at some point, although there is an open issue to separate these options.