@@ -81,12 +81,13 @@ use bevy_utils::TypeIdMap;
81
81
use core:: { any:: TypeId , ptr:: NonNull } ;
82
82
use variadics_please:: all_tuples;
83
83
84
+ /// A collection of components, whose identity may or may not be fixed at compile time.
85
+ ///
84
86
/// The `Bundle` trait enables insertion of [`Component`]s to an entity.
85
87
/// For the removal of [`Component`]s from an entity see the [`StaticBundle`]`trait`.
86
88
///
87
89
/// Implementers of the `Bundle` trait are called 'bundles'.
88
90
///
89
- /// Each bundle represents a possibly dynamic set of [`Component`] types.
90
91
/// Currently, bundles can only contain one of each [`Component`], and will
91
92
/// panic once initialized if this is not met.
92
93
///
@@ -214,10 +215,10 @@ pub unsafe trait Bundle: DynamicBundle + Send + Sync + 'static {
214
215
) ;
215
216
}
216
217
217
- /// Each bundle represents a static and fixed set of [`Component`] types.
218
+ /// A static and fixed set of [`Component`] types.
218
219
/// See the [`Bundle`] trait for a possibly dynamic set of [`Component`] types.
219
220
///
220
- /// Implementers of the `Bundle` trait are called 'static bundles'.
221
+ /// Implementers of the [`StaticBundle`] trait are called 'static bundles'.
221
222
///
222
223
/// ## Removal
223
224
///
@@ -233,7 +234,8 @@ pub unsafe trait Bundle: DynamicBundle + Send + Sync + 'static {
233
234
/// Manual implementations of this trait are unsupported.
234
235
/// That is, there is no safe way to implement this trait, and you must not do so.
235
236
/// If you want a type to implement [`StaticBundle`], you must use [`derive@Bundle`](derive@Bundle).
236
- // Some safety points:
237
+ //
238
+ // (bevy internal doc) Some safety points:
237
239
// - [`StaticBundle::component_ids`] and [`StaticBundle::get_component_ids`] must match the behavior of [`Bundle::component_ids`]
238
240
#[ diagnostic:: on_unimplemented(
239
241
message = "`{Self}` is not a `StaticBundle`" ,
0 commit comments