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

Add status field to other replies in documentation #648

Merged
merged 1 commit into from
Jul 30, 2021
Merged

Add status field to other replies in documentation #648

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 13 additions & 1 deletion docs/messaging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -782,6 +782,9 @@ Message type: ``history_request``::
Message type: ``history_reply``::

content = {
# 'ok' if the request succeeded or 'error', with error information as in all other replies.
'status' : 'ok',

# A list of 3 tuples, either:
# (session, line_number, input) or
# (session, line_number, (input, output)),
Expand Down Expand Up @@ -899,6 +902,9 @@ Message type: ``comm_info_request``::
Message type: ``comm_info_reply``::

content = {
# 'ok' if the request succeeded or 'error', with error information as in all other replies.
'status' : 'ok',

# A dictionary of the comms, indexed by uuids.
'comms': {
comm_id: {
Expand Down Expand Up @@ -1048,6 +1054,9 @@ Message type: ``shutdown_request``::
Message type: ``shutdown_reply``::

content = {
# 'ok' if the request succeeded or 'error', with error information as in all other replies.
'status' : 'ok',

'restart' : bool # False if final shutdown, or True if shutdown precedes a restart
}

Expand Down Expand Up @@ -1078,7 +1087,10 @@ Message type: ``interrupt_request``::

Message type: ``interrupt_reply``::

content = {}
content = {
# 'ok' if the request succeeded or 'error', with error information as in all other replies.
'status' : 'ok'
}

.. versionadded:: 5.3

Expand Down