Skip to content

Commit 4738e6a

Browse files
authored
Merge pull request #462 from takluyver/exec-count-ambiguities
Fix ambiguous specification around execution_reply field
2 parents 2b1a6e7 + 18bf345 commit 4738e6a

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/messaging.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,9 @@ All reply messages have a ``'status'`` field, which will have one of the followi
305305
but with no information about the error.
306306
No fields should be present other that `status`.
307307

308+
As a special case, ``execute_reply`` messages (see :ref:`execution_results`)
309+
have an ``execution_count`` field regardless of their status.
310+
308311
.. versionchanged:: 5.1
309312

310313
``status='abort'`` has not proved useful, and is considered deprecated.
@@ -1187,7 +1190,7 @@ Message type: ``error``::
11871190

11881191
content = {
11891192
# Similar content to the execute_reply messages for the 'error' case,
1190-
# except the 'status' field is omitted.
1193+
# except the 'status' and 'execution_count' fields are omitted.
11911194
}
11921195

11931196
.. versionchanged:: 5.0

0 commit comments

Comments
 (0)