Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs mistake in bevy_ecs::world #17336

Merged
merged 3 commits into from
Jan 28, 2025
Merged

Fix docs mistake in bevy_ecs::world #17336

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5342e40
Fix docs mistake in bevy_ecs::world
berylllium Jan 13, 2025
8f5aae7
Change phrasing rustdoc change
berylllium Jan 14, 2025
3987bb0
Merge branch 'main' into docs_world_fix
berylllium Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions crates/bevy_ecs/src/world/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,8 @@ use unsafe_world_cell::{UnsafeEntityCell, UnsafeWorldCell};
/// Stores and exposes operations on [entities](Entity), [components](Component), resources,
/// and their associated metadata.
///
/// Each [`Entity`] has a set of components. Each component can have up to one instance of each
/// component type. Entity components can be created, updated, removed, and queried using a given
/// [`World`].
/// Each [`Entity`] can have up to one instance of each type of component. Entity
/// components can be created, updated, removed, and queried using a given [`World`].
Copy link
Contributor

@LikeLakers2 LikeLakers2 Jan 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps something like

Each Entity has a set of components, but only one instance of each type of component.

so that it's clear that multiple types of components can exist, but only one of each type.

Suggested change
/// Each [`Entity`] can have up to one instance of each type of component. Entity
/// components can be created, updated, removed, and queried using a given [`World`].
/// Each [`Entity`] has a set of components, but only one instance of each type of
/// component. Entity components can be created, updated, removed, and queried using
/// a given [`World`].

///
/// For complex access patterns involving [`SystemParam`](crate::system::SystemParam),
/// consider using [`SystemState`](crate::system::SystemState).
Expand Down
Loading