Skip to content

Commit

Permalink
Update failed_command docstring.
Browse files Browse the repository at this point in the history
  • Loading branch information
SyntaxColoring committed Mar 19, 2024
1 parent 641fff2 commit 44eeb21
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion api/src/opentrons/protocol_engine/state/commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,12 @@ class CommandState:
"""

failed_command: Optional[CommandEntry]
"""The command, if any, that made the run fail and the index in the command list."""
"""The most recent command failure, if any."""
# TODO(mm, 2024-03-19): This attribute is currently only used to help robot-server
# with pagination, but "the failed command" is an increasingly nuanced idea, now
# that we're doing error recovery. See if we can implement robot-server pagination
# atop simpler concepts, like "the last command that ran" or "the next command that
# would run."

finish_error: Optional[ErrorOccurrence]
"""The error that happened during the post-run finish steps (homing & dropping tips), if any."""
Expand Down

0 comments on commit 44eeb21

Please sign in to comment.