Fix naming on "tick" Column and ComponentSparseSet methods #9744
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
nicopap
added
A-ECS
nicopap
changed the title
alice-i-cecile
added
the
C-Code-Quality
alice-i-cecile
approved these changes
Sep 10, 2023
JoJoJet
reviewed
Sep 10, 2023
mockersf
approved these changes
Sep 10, 2023
|
@JoJoJet I think the compiler should be good enough at directing users. The name are similar enough that the error message from the error should include the updated name and be enough guidance. Since releases are expected to be breaking, I don't think a deprecation is needed in this case. |
alice-i-cecile
added
the
S-Ready-For-Final-Review
rdrpenguin04
pushed a commit
to rdrpenguin04/bevy
that referenced
this pull request
Jan 9, 2024
…e#9744) # Objective - The tick access methods mention "ticks" (as in: plural). Yet, most of them only access a single tick. ## Solution - Rename those methods and fix docs to reflect the singular aspect of the return values --- ## Migration Guide The following method names were renamed, from `foo_ticks_bar` to `foo_tick_bar` (`ticks` is now singular, `tick`): - `ComponentSparseSet::get_added_ticks` → `get_added_tick` - `ComponentSparseSet::get_changed_ticks` → `get_changed_tick` - `Column::get_added_ticks` → `get_added_tick` - `Column::get_changed_ticks` → `get_changed_tick` - `Column::get_added_ticks_unchecked` → `get_added_tick_unchecked` - `Column::get_changed_ticks_unchecked` → `get_changed_tick_unchecked`
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
Solution
Migration Guide
The following method names were renamed, from
foo_ticks_bartofoo_tick_bar(ticksis now singular,tick):ComponentSparseSet::get_added_ticks→get_added_tickComponentSparseSet::get_changed_ticks→get_changed_tickColumn::get_added_ticks→get_added_tickColumn::get_changed_ticks→get_changed_tickColumn::get_added_ticks_unchecked→get_added_tick_uncheckedColumn::get_changed_ticks_unchecked→get_changed_tick_unchecked