Skip to content

Commit 0b824b3

Browse files
clean up entity_location comments
1 parent 0eff0a0 commit 0b824b3

File tree

1 file changed

+6
-6
lines changed
  • crates/bevy_ecs/src/storage

1 file changed

+6
-6
lines changed

crates/bevy_ecs/src/storage/mod.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ impl Storages {
3030
/// Get a raw pointer to a particular [`Component`](crate::component::Component) and its [`ComponentTicks`] identified by their [`TypeId`]
3131
///
3232
/// # Safety
33-
/// - `entity_location` must be within bounds of the given archetype and `entity` must exist inside
3433
/// - `storage_type` must accurately reflect where the components for `component_id` are stored.
34+
/// - `location` must refer to an archetype that contains `entity`
3535
/// - `Archetypes` and `Components` must come from the world this of this `Storages`
3636
/// - the caller must ensure that no aliasing rules are violated
3737
#[inline]
@@ -52,7 +52,7 @@ impl Storages {
5252
/// Get a raw pointer to a particular [`Component`](crate::component::Component) and its [`ComponentTicks`]
5353
///
5454
/// # Safety
55-
/// - `entity_location` must be within bounds of the given archetype and `entity` must exist inside
55+
/// - `location` must refer to an archetype that contains `entity`
5656
/// - `component_id` must be valid
5757
/// - `storage_type` must accurately reflect where the components for `component_id` are stored.
5858
/// - `Archetypes` and `Components` must come from the world this of this `Storages`
@@ -87,7 +87,7 @@ impl Storages {
8787
/// Get a raw pointer to a particular [`Component`](crate::component::Component) on a particular [`Entity`], identified by the component's type
8888
///
8989
/// # Safety
90-
/// - `entity_location` must be within bounds of the given archetype and `entity` must exist inside
90+
/// - `location` must refer to an archetype that contains `entity`
9191
/// the archetype
9292
/// - `storage_type` must accurately reflect where the components for `component_id` are stored.
9393
/// - `Archetypes` and `Components` must come from the world this of this `Storages`
@@ -110,7 +110,7 @@ impl Storages {
110110
/// Get a raw pointer to a particular [`Component`](crate::component::Component) on a particular [`Entity`] in the provided [`World`](crate::world::World).
111111
///
112112
/// # Safety
113-
/// - `entity_location` must be within bounds of the given archetype and `entity` must exist inside
113+
/// - `location` must refer to an archetype that contains `entity`
114114
/// the archetype
115115
/// - `component_id`
116116
/// - `storage_type` must accurately reflect where the components for `component_id` are stored.
@@ -140,7 +140,7 @@ impl Storages {
140140
/// Get a raw pointer to the [`ComponentTicks`] on a particular [`Entity`], identified by the component's [`TypeId`]
141141
///
142142
/// # Safety
143-
/// - `entity_location` must be within bounds of the given archetype and `entity` must exist inside
143+
/// - `location` must refer to an archetype that contains `entity`
144144
/// the archetype
145145
/// - `storage_type` must accurately reflect where the components for `component_id` are stored.
146146
/// - `Archetypes` and `Components` must come from the world this of this `Storages`
@@ -163,7 +163,7 @@ impl Storages {
163163
/// Get a raw pointer to the [`ComponentTicks`] on a particular [`Entity`]
164164
///
165165
/// # Safety
166-
/// - `entity_location` must be within bounds of the given archetype and `entity` must exist inside
166+
/// - `location` must refer to an archetype that contains `entity`
167167
/// the archetype
168168
/// - `component_id` must be valid
169169
/// - `storage_type` must accurately reflect where the components for `component_id` are stored.

0 commit comments

Comments
 (0)