Skip to content

Commit 37223f2

Browse files
clean up entity_location comments
1 parent 143f4ec commit 37223f2

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
@@ -29,8 +29,8 @@ impl Storages {
2929
/// Get a raw pointer to a particular [`Component`](crate::component::Component) and its [`ComponentTicks`] identified by their [`TypeId`]
3030
///
3131
/// # Safety
32-
/// - `entity_location` must be within bounds of the given archetype and `entity` must exist inside
3332
/// - `storage_type` must accurately reflect where the components for `component_id` are stored.
33+
/// - `location` must refer to an archetype that contains `entity`
3434
/// - `Archetypes` and `Components` must come from the world this of this `Storages`
3535
/// - the caller must ensure that no aliasing rules are violated
3636
#[inline]
@@ -51,7 +51,7 @@ impl Storages {
5151
/// Get a raw pointer to a particular [`Component`](crate::component::Component) and its [`ComponentTicks`]
5252
///
5353
/// # Safety
54-
/// - `entity_location` must be within bounds of the given archetype and `entity` must exist inside
54+
/// - `location` must refer to an archetype that contains `entity`
5555
/// - `component_id` must be valid
5656
/// - `storage_type` must accurately reflect where the components for `component_id` are stored.
5757
/// - `Archetypes` and `Components` must come from the world this of this `Storages`
@@ -86,7 +86,7 @@ impl Storages {
8686
/// Get a raw pointer to a particular [`Component`](crate::component::Component) on a particular [`Entity`], identified by the component's type
8787
///
8888
/// # Safety
89-
/// - `entity_location` must be within bounds of the given archetype and `entity` must exist inside
89+
/// - `location` must refer to an archetype that contains `entity`
9090
/// the archetype
9191
/// - `storage_type` must accurately reflect where the components for `component_id` are stored.
9292
/// - `Archetypes` and `Components` must come from the world this of this `Storages`
@@ -109,7 +109,7 @@ impl Storages {
109109
/// Get a raw pointer to a particular [`Component`](crate::component::Component) on a particular [`Entity`] in the provided [`World`](crate::world::World).
110110
///
111111
/// # Safety
112-
/// - `entity_location` must be within bounds of the given archetype and `entity` must exist inside
112+
/// - `location` must refer to an archetype that contains `entity`
113113
/// the archetype
114114
/// - `component_id`
115115
/// - `storage_type` must accurately reflect where the components for `component_id` are stored.
@@ -139,7 +139,7 @@ impl Storages {
139139
/// Get a raw pointer to the [`ComponentTicks`] on a particular [`Entity`], identified by the component's [`TypeId`]
140140
///
141141
/// # Safety
142-
/// - `entity_location` must be within bounds of the given archetype and `entity` must exist inside
142+
/// - `location` must refer to an archetype that contains `entity`
143143
/// the archetype
144144
/// - `storage_type` must accurately reflect where the components for `component_id` are stored.
145145
/// - `Archetypes` and `Components` must come from the world this of this `Storages`
@@ -162,7 +162,7 @@ impl Storages {
162162
/// Get a raw pointer to the [`ComponentTicks`] on a particular [`Entity`]
163163
///
164164
/// # Safety
165-
/// - `entity_location` must be within bounds of the given archetype and `entity` must exist inside
165+
/// - `location` must refer to an archetype that contains `entity`
166166
/// the archetype
167167
/// - `component_id` must be valid
168168
/// - `storage_type` must accurately reflect where the components for `component_id` are stored.

0 commit comments

Comments
 (0)