Skip to content

Commit 939df2b

Browse files
committed
update docs
1 parent 760a9e1 commit 939df2b

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

crates/bevy_ecs/src/system/commands/fallible.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@ use crate::world::World;
33
use bevy_utils::tracing::error;
44
use std::fmt::Debug;
55

6-
/// TODO:
6+
/// The error struct provided to command error handlers.
7+
/// This contains both the error, and a mutable reference to [`World`].
78
pub struct CommandError<'a, C: FallibleCommand> {
89
pub error: C::Error,
910
pub world: &'a mut World,
1011
}
1112

12-
/// Used for specifying and error for a command.
13+
/// A [`World`] mutation that can potentially fail.
14+
/// For an infallible variant, use [`Command`].
1315
pub trait FallibleCommand: Send + Sync + 'static {
1416
type Error;
1517

0 commit comments

Comments
 (0)