Skip to content

Commit a849db1

Browse files
committed
doc: fix docs on stf
1 parent 76f7b84 commit a849db1

1 file changed

Lines changed: 1 addition & 2 deletions

File tree

  • crates/state-machine/api/src

crates/state-machine/api/src/spec.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ pub trait StateMachineSpec {
1919
/// Actions MUST be replay safe.
2020
type Action;
2121

22-
/// The state transition function. Takes config, mutable state, and input, updating the mutable
23-
/// state. Should return true if there was a state change, false if no change
22+
/// The state transition function. Takes config, state, and input, returning the next state.
2423
fn stf(config: &Self::Config, state: Self::State, input: Self::Input) -> Self::State;
2524

2625
/// Emit actions based on current state.

0 commit comments

Comments
 (0)