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.

Sign up for GitHub

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

Jump to bottom

Rename UnsafeWorldCell::read_change_tick #8588

Merged
merged 4 commits into from
May 11, 2023
Merged

Rename UnsafeWorldCell::read_change_tick #8588

merged 4 commits into from
May 11, 2023

Conversation

JoJoJet
Copy link
Member

@JoJoJet JoJoJet commented May 10, 2023

Objective

The method UnsafeWorldCell::read_change_tick is longer than it needs to be. World only has a method called this because it has two methods for getting a change tick: one that takes &self and one that takes &mut self. Since this distinction is not applicable to UnsafeWorldCell, we should just call this method change_tick.

Solution

Deprecate the current method and add a new one called change_tick.

Changelog

  • Renamed UnsafeWorldCell::read_change_tick to change_tick.

Migration Guide

The UnsafeWorldCell method read_change_tick has been renamed to change_tick.

@JoJoJet JoJoJet added A-ECS Entities, components, systems, and events C-Usability A simple quality-of-life change that makes Bevy easier to use labels May 10, 2023
@alice-i-cecile alice-i-cecile added the C-Breaking-Change A breaking change to Bevy's public API that needs to be noted in a migration guide label May 10, 2023
@james7132 james7132 added this pull request to the merge queue May 10, 2023
@james7132 james7132 modified the milestones: 0.10.2, 0.11 May 10, 2023
Merged via the queue into bevyengine:main with commit 35240fe May 11, 2023
@JoJoJet JoJoJet deleted the read-change-tick branch May 11, 2023 00:16
@JoJoJet JoJoJet mentioned this pull request Jun 14, 2023
Merged
alice-i-cecile pushed a commit that referenced this pull request Jun 14, 2023
@JoJoJet
Rename a leftover usage of a renamed function read_change_tick (#8837)
2551ccb 
# Objective

The method `UnsafeWorldCell::read_change_tick` was renamed in #8588, but
I forgot to update a usage of this method in a doctest.

## Solution

Update the method call.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@james7132 james7132 james7132 approved these changes

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

Assignees
No one assigned
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
Projects
None yet
Milestone
0.11
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@JoJoJet @james7132 @alice-i-cecile