From 711d50b9e65959bf191527a5f0116c07f50f9da2 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 12 Mar 2026 06:57:45 +0000 Subject: [PATCH] docs: fix incorrect reset() example in README The Reset section showed reset() succeeding from RED, but RED is terminal and reset() raises TerminalStateError. Updated the example to show reset from AMBER (the valid case) and document that reset from RED raises. Co-Authored-By: Claude Opus 4.6 --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 02f7158..ecd5ea5 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,12 @@ m.transition_to(State.GREEN) # raises InvalidTransitionError ## Reset ```python +m = StopMachine() +m.advance() # -> AMBER +m.reset() # -> GREEN + m = StopMachine(State.RED) -m.reset() # -> GREEN +m.reset() # raises TerminalStateError ``` ## Run tests