Skip to content

Commit

Permalink
docs(api): Update reference docs for ProtocolContext.pause() (#14500)
Browse files Browse the repository at this point in the history
Co-authored-by: Ed Cormany <[email protected]>
  • Loading branch information
SyntaxColoring and ecormany authored Feb 15, 2024
1 parent 2aa767f commit 678d5c1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions api/src/opentrons/protocol_api/protocol_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -979,9 +979,9 @@ def pause(self, msg: Optional[str] = None) -> None:
A human can resume the protocol in the Opentrons App or on the touchscreen.
This function returns immediately, but the next function call that
is blocked by a paused robot (anything that involves moving) will
not return until the protocol is resumed.
.. note::
In Python Protocol API version 2.13 and earlier, the pause will only
take effect on the next function call that involves moving the robot.
:param str msg: An optional message to show in the run log entry for the pause step.
"""
Expand Down

0 comments on commit 678d5c1

Please sign in to comment.