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.

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

Clarify stop_on_error documentation. #422

Merged
merged 1 commit into from
Feb 15, 2019
Merged
Changes from all commits
Commits
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 docs/messaging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -351,9 +351,9 @@ Message type: ``execute_request``::
# should not send these messages.
'allow_stdin' : True,

# A boolean flag, which, if True, does not abort the execution queue, if an exception is encountered.
# This allows the queued execution of multiple execute_requests, even if they generate exceptions.
'stop_on_error' : False,
# A boolean flag, which, if True, aborts the execution queue if an exception is encountered.
# If False, queued execute_requests will execute even if this request generates an exception.
'stop_on_error' : True,
}

.. versionchanged:: 5.0
Expand Down