Skip to content

Commit b459828

Browse files
committed
Apply suggestions
1 parent 20fef0c commit b459828

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

crates/bevy_ecs/src/bundle.rs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ use bevy_utils::TypeIdMap;
8181
use core::{any::TypeId, ptr::NonNull};
8282
use variadics_please::all_tuples;
8383

84+
/// A collection of components, whose identity may or may not be fixed at compile time.
85+
///
8486
/// The `Bundle` trait enables insertion of [`Component`]s to an entity.
8587
/// For the removal of [`Component`]s from an entity see the [`StaticBundle`]`trait`.
8688
///
@@ -214,10 +216,10 @@ pub unsafe trait Bundle: DynamicBundle + Send + Sync + 'static {
214216
);
215217
}
216218

217-
/// Each bundle represents a static and fixed set of [`Component`] types.
219+
/// A static and fixed set of [`Component`] types.
218220
/// See the [`Bundle`] trait for a possibly dynamic set of [`Component`] types.
219221
///
220-
/// Implementers of the `Bundle` trait are called 'static bundles'.
222+
/// Implementers of the [`StaticBundle`] trait are called 'static bundles'.
221223
///
222224
/// ## Removal
223225
///
@@ -233,7 +235,8 @@ pub unsafe trait Bundle: DynamicBundle + Send + Sync + 'static {
233235
/// Manual implementations of this trait are unsupported.
234236
/// That is, there is no safe way to implement this trait, and you must not do so.
235237
/// If you want a type to implement [`StaticBundle`], you must use [`derive@Bundle`](derive@Bundle).
236-
// Some safety points:
238+
//
239+
// (bevy internal doc) Some safety points:
237240
// - [`StaticBundle::component_ids`] and [`StaticBundle::get_component_ids`] must match the behavior of [`Bundle::component_ids`]
238241
#[diagnostic::on_unimplemented(
239242
message = "`{Self}` is not a `StaticBundle`",

release-content/migration-guides/static-bundle-split.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: StaticBundle split off from Bundle
2+
title: \`StaticBundle` has been split off from `Bundle`
33
pull_requests: [19491]
44
---
55

0 commit comments

Comments
 (0)