Skip to content

Commit 769c9b8

Browse files
committed
add staticsysteminput to systeminput docs
1 parent 4c5c28e commit 769c9b8

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

crates/bevy_ecs/src/system/input.rs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,18 @@ use crate::{bundle::Bundle, prelude::Trigger, system::System};
1010
/// - [`InRef<T>`]: For read-only references to values
1111
/// - [`InMut<T>`]: For mutable references to values
1212
/// - [`Trigger<E, B>`]: For [`ObserverSystem`]s
13+
/// - [`StaticSystemInput<I>`]: For arbitrary [`SystemInput`]s in generic contexts
1314
///
1415
/// [`ObserverSystem`]: crate::system::ObserverSystem
1516
pub trait SystemInput: Sized {
16-
/// The outer input type that is defined as the first argument to systems,
17-
/// similar to [`SystemParam`](crate::system::SystemParam)s.
17+
/// The wrapper input type that is defined as the first argument to [`FunctionSystem`]s.
18+
///
19+
/// [`FunctionSystem`]: crate::system::FunctionSystem
1820
type Param<'i>: SystemInput;
19-
/// The inner input type that is passed to system run functions.
21+
/// The inner input type that is passed to functions that run systems,
22+
/// such as [`System::run`].
23+
///
24+
/// [`System::run`]: crate::system::System::run
2025
type Inner<'i>;
2126

2227
/// Converts a [`SystemInput::Param`] into a [`SystemInput::Inner`].

0 commit comments

Comments
 (0)