Skip to content

Commit

Permalink
doc: clarify FSM doc.
Browse files Browse the repository at this point in the history
whitequark committed Oct 17, 2016
1 parent 20ef480 commit c43fb67
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions migen/genlib/fsm.py
Original file line number Diff line number Diff line change
@@ -86,9 +86,11 @@ class FSM(Module):
"""
Finite state machine
Any Python objects can be used as states, e.g. strings.
Parameters
----------
reset_state : str
reset_state
Reset state. Defaults to the first added state.
Examples
@@ -139,7 +141,7 @@ def act(self, state, *statements):
`self.comb += a.eq(b)` when the FSM is in the given `state`;
* synchronous statements of form `NextValue(a, b)`, equivalent to
`self.sync += a.eq(b)` when the FSM is in the given `state`;
* a statement of form `NextState("STATE")`, selecting the next state;
* a statement of form `NextState(new_state)`, selecting the next state;
* `If`, `Case`, etc.
"""
if self.finalized:

0 comments on commit c43fb67

Please sign in to comment.