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

Updated FromWorld Documentation to mention Default (#14954)

Browse Source 
# Objective

- Fixes #14860

## Solution

- Added a line of documentation to `FromWorld`'s trait definition
mention the `Default` blanket implementation.
- Added custom documentation to the `from_world` method for the
`Default` blanket implementation. This ensures when inspecting the
`from_world` function within an IDE, the tooltip will explicitly state
the `default()` method will be used for any `Default` types.

## Testing

- CI passes.
This commit is contained in:
Zachary Harrold 2024-08-28 21:37:31 +10:00 committed by GitHub
parent 210c79c9f9
commit 371e07e77d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2949,12 +2949,15 @@ unsafe impl Sync for World {}
/// using data from the supplied [`World`]. /// using data from the supplied [`World`].
/// ///
/// This can be helpful for complex initialization or context-aware defaults. /// This can be helpful for complex initialization or context-aware defaults.
///
/// [`FromWorld`] is automatically implemented for any type implementing [`Default`].
pub trait FromWorld { pub trait FromWorld {
/// Creates `Self` using data from the given [`World`]. /// Creates `Self` using data from the given [`World`].
fn from_world(world: &mut World) -> Self; fn from_world(world: &mut World) -> Self;
} }
impl<T: Default> FromWorld for T { impl<T: Default> FromWorld for T {
/// Creates `Self` using [`default()`](`Default::default`).
fn from_world(_world: &mut World) -> Self { fn from_world(_world: &mut World) -> Self {
T::default() T::default()
} }