Skip to content

Commit

Permalink
Add missing docs to World::change_tick and World::read_change_tick (
Browse files Browse the repository at this point in the history
bevyengine#6765)

# Objective

The methods `World::change_tick` and `World::read_change_tick` lack documentation and have confusingly similar behavior.

## Solution

Add documentation and clarify the distinction between the two functions.
  • Loading branch information
JoJoJet committed Dec 5, 2022
1 parent b337ed6 commit 83e8224
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions crates/bevy_ecs/src/world/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1396,11 +1396,19 @@ impl World {
self.change_tick.fetch_add(1, Ordering::AcqRel)
}

/// Reads the current change tick of this world.
///
/// If you have exclusive (`&mut`) access to the world, consider using [`change_tick()`](Self::change_tick),
/// which is more efficient since it does not require atomic synchronization.
#[inline]
pub fn read_change_tick(&self) -> u32 {
self.change_tick.load(Ordering::Acquire)
}

/// Reads the current change tick of this world.
///
/// This does the same thing as [`read_change_tick()`](Self::read_change_tick), only this method
/// is more efficient since it does not require atomic synchronization.
#[inline]
pub fn change_tick(&mut self) -> u32 {
*self.change_tick.get_mut()
Expand Down

0 comments on commit 83e8224

Please sign in to comment.