forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix docs mistake in bevy_ecs::world (#17336)

Browse Source 
# Objective

- Correct a mistake in the rustdoc for bevy_ecs::world::World.

## Solution

- The rustdoc wrongly stated that "Each component can have up to one
instance of each component type.". This sentence should presumably be
"Each *Entity* can have up to one instance of each component type.".
Applying this change makes the prior sentence "Each [`Entity`] has a set
of components." redundant.

---------

Co-authored-by: François Mockers <francois.mockers@vleue.com>
This commit is contained in:
berry 2025-01-28 06:20:31 +01:00 committed by GitHub
parent 581034a7e9
commit 95174f3c6e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
crates/bevy_ecs/src/world/mod.rs
View File

@ -70,9 +70,8 @@ use core::panic::Location;
/// Stores and exposes operations on [entities](Entity), [components](Component), resources, /// Stores and exposes operations on [entities](Entity), [components](Component), resources,
/// and their associated metadata. /// and their associated metadata.
/// ///
/// Each [`Entity`] has a set of components. Each component can have up to one instance of each /// Each [`Entity`] has a set of unique components, based on their type.
/// component type. Entity components can be created, updated, removed, and queried using a given /// Entity components can be created, updated, removed, and queried using a given
/// [`World`].
/// ///
/// For complex access patterns involving [`SystemParam`](crate::system::SystemParam), /// For complex access patterns involving [`SystemParam`](crate::system::SystemParam),
/// consider using [`SystemState`](crate::system::SystemState). /// consider using [`SystemState`](crate::system::SystemState).