Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(api): Update reference docs for ProtocolContext.pause() #14500

Merged
merged 3 commits into from
Feb 15, 2024
Merged

docs(api): Update reference docs for ProtocolContext.pause() #14500

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2d3481a
Fix pause docs.
SyntaxColoring Feb 15, 2024
c4a8045
Merge branch 'edge' into pause_docs_fix
SyntaxColoring Feb 15, 2024
d374264
Singular version.
SyntaxColoring Feb 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions api/src/opentrons/protocol_api/protocol_context.py
View file
Open in desktop
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
Loading