Skip to content

Commit c3231ac

Browse files
authored
Merge pull request #454 from flying-sheep/patch-1
Harmonize “status” field
2 parents 43c9c2f + 3968ab0 commit c3231ac

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/messaging.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -614,6 +614,11 @@ Message type: ``complete_request``::
614614
Message type: ``complete_reply``::
615615

616616
content = {
617+
# status should be 'ok' unless an exception was raised during the request,
618+
# in which case it should be 'error', along with the usual error message content
619+
# in other messages.
620+
'status' : 'ok'
621+
617622
# The list of all matches to the completion request, such as
618623
# ['a.isalnum', 'a.isalpha'] for the above example.
619624
'matches' : list,
@@ -625,11 +630,6 @@ Message type: ``complete_reply``::
625630

626631
# Information that frontend plugins might use for extra display information about completions.
627632
'metadata' : dict,
628-
629-
# status should be 'ok' unless an exception was raised during the request,
630-
# in which case it should be 'error', along with the usual error message content
631-
# in other messages.
632-
'status' : 'ok'
633633
}
634634

635635
.. versionchanged:: 5.0
@@ -835,6 +835,9 @@ Message type: ``kernel_info_request``::
835835
Message type: ``kernel_info_reply``::
836836

837837
content = {
838+
# 'ok' if the request succeeded or 'error', with error information as in all other replies.
839+
'status' : 'ok',
840+
838841
# Version of messaging protocol.
839842
# The first integer indicates major version. It is incremented when
840843
# there is any backward incompatible change.

0 commit comments

Comments
 (0)