Skip to content

docs: fix incorrect reset() example in README#8

Open
LalaSkye wants to merge 1 commit intomainfrom
docs/fix-reset-example
Open

docs: fix incorrect reset() example in README#8
LalaSkye wants to merge 1 commit intomainfrom
docs/fix-reset-example

Conversation

@LalaSkye
Copy link
Owner

Summary

  • Fixed the Reset section in README.md which incorrectly showed reset() succeeding from RED state
  • RED is terminal — reset() raises TerminalStateError (confirmed by test_reset_from_red and stop_machine.py:95-98)
  • Updated example to show reset from AMBER (valid case) and document that reset from RED raises

Test plan

  • Verify the README example matches the behavior in stop_machine.py (reset() method, lines 93-100)
  • Verify pytest test_stop_machine.py -v still passes (no code changes, docs only)

🤖 Generated with Claude Code

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 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants