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

Rename RemovedComponents::iter/iter_with_id to read/read_with_id #9778

Merged
merged 4 commits into from
Sep 15, 2023

Conversation

louis-le-cam
Copy link
Contributor

@louis-le-cam louis-le-cam commented Sep 12, 2023

Objective

Rename RemovedComponents::iter/iter_with_id to read/read_with_id to make it clear that it consume the data

Fixes #9755.

(It's my first pull request, if i've made any mistake, please let me know)

Solution

Refactor RemovedComponents::iter/iter_with_id to read/read_with_id

Changelog

Refactor RemovedComponents::iter/iter_with_id to read/read_with_id

Deprecate RemovedComponents::iter/iter_with_id

Remove IntoIterator implementation

Update removal_detection example accordingly


Migration Guide

Rename calls of RemovedComponents::iter/iter_with_id to read/read_with_id

Replace IntoIterator iteration (&mut ) with .read()

@github-actions
Copy link
Contributor

Welcome, new contributor!

Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨

@louis-le-cam louis-le-cam changed the title Fix 9755: Rename RemovedComponents::iter/iter_with_id to read/read_with_id Rename RemovedComponents::iter/iter_with_id to read/read_with_id Sep 13, 2023
@alice-i-cecile alice-i-cecile added A-ECS Entities, components, systems, and events C-Usability A simple quality-of-life change that makes Bevy easier to use labels Sep 13, 2023
Copy link
Contributor

@Shatur Shatur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nicely done and consistent with Event, I like it.

crates/bevy_ecs/src/removal_detection.rs Show resolved Hide resolved
crates/bevy_ecs/src/removal_detection.rs Outdated Show resolved Hide resolved
crates/bevy_ecs/src/removal_detection.rs Show resolved Hide resolved
@james7132 james7132 added the C-Breaking-Change A breaking change to Bevy's public API that needs to be noted in a migration guide label Sep 14, 2023
@alice-i-cecile alice-i-cecile added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Sep 15, 2023
@alice-i-cecile alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Sep 15, 2023
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Sep 15, 2023
Merged via the queue into bevyengine:main with commit 9ee9d62 Sep 15, 2023
22 checks passed
rdrpenguin04 pushed a commit to rdrpenguin04/bevy that referenced this pull request Jan 9, 2024
…yengine#9778)

# Objective

Rename RemovedComponents::iter/iter_with_id to read/read_with_id to make
it clear that it consume the data

Fixes bevyengine#9755.

(It's my first pull request, if i've made any mistake, please let me
know)

## Solution

Refactor RemovedComponents::iter/iter_with_id to read/read_with_id



## Changelog

Refactor RemovedComponents::iter/iter_with_id to read/read_with_id

Deprecate RemovedComponents::iter/iter_with_id

Remove IntoIterator implementation

Update removal_detection example accordingly

---

## Migration Guide

Rename calls of RemovedComponents::iter/iter_with_id to
read/read_with_id

Replace IntoIterator iteration (&mut <RemovedComponents>) with .read()

---------

Co-authored-by: denshi_ika <mojang2824@gmail.com>
@louis-le-cam louis-le-cam deleted the fix-9755 branch February 7, 2024 08:51
@louis-le-cam louis-le-cam restored the fix-9755 branch February 7, 2024 08:51
@louis-le-cam louis-le-cam deleted the fix-9755 branch February 7, 2024 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ECS Entities, components, systems, and events C-Breaking-Change A breaking change to Bevy's public API that needs to be noted in a migration guide C-Usability A simple quality-of-life change that makes Bevy easier to use S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename RemovedComponents::iter
6 participants