Skip to content

Commit f5468c7

Browse files
committed
Provide better frontend description, fix ReST syntax errors.
1 parent fab26d8 commit f5468c7

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/messaging.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1015,12 +1015,12 @@ document formats and is fully optional. The only transient key currently defined
10151015
Update Display Data
10161016
-------------------
10171017

1018-
Displays can now be named with a `display_id`` within the ``transient`` field of
1018+
Displays can now be named with a ``display_id`` within the ``transient`` field of
10191019
``display_data`` or ``execute_result``.
10201020

10211021
When a ``display_id`` is specified for a display, it can be updated later
10221022
with an ``update_display_data`` message. This message has the same format as `display_data`_
1023-
messages and must contain a ```transient`` field with a ``display_id``.
1023+
messages and must contain a ``transient`` field with a ``display_id``.
10241024

10251025
.. _update_display_data:
10261026

@@ -1041,6 +1041,10 @@ Message type: ``update_display_data``::
10411041
'transient': dict,
10421042
}
10431043

1044+
Frontends can choose how they update prior outputs (or if they regard this as a
1045+
regular ``display_data`` message). Within the jupyter and nteract_ notebooks,
1046+
all displays that match the ``display_id`` are updated (even if there are multiple).
1047+
10441048
Code inputs
10451049
-----------
10461050

@@ -1337,3 +1341,4 @@ Missing things include:
13371341
* Important: finish thinking through the payload concept and API.
13381342

13391343
.. _ZeroMQ: http://zeromq.org
1344+
.. _nteract: https://nteract.io

0 commit comments

Comments
 (0)