Skip to content

Commit 7e5bb9c

Browse files
committed
Provide description of display_id and update_display_data
1 parent 7caed53 commit 7e5bb9c

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

docs/messaging.rst

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1000,7 +1000,12 @@ and expanded for JSON data::
10001000

10011001

10021002
The ``transient`` dict contains runtime metadata that should not be persisted to
1003-
document formats. The first field used in transient is `display_id`.
1003+
document formats. The only transient key currently defined in Jupyter is
1004+
``display_id``::
1005+
1006+
transient = {
1007+
'display_id': 'abcd'
1008+
}
10041009

10051010
.. versionchanged:: 5.0
10061011

@@ -1010,8 +1015,12 @@ document formats. The first field used in transient is `display_id`.
10101015
Update Display Data
10111016
-------------------
10121017

1013-
This message has the same format as `display_data`_ messages and must contain
1014-
a ```transient`` field with a ``display_id``.
1018+
Displays can now be named with a `display_id`` within the ``transient`` field of
1019+
``display_data`` or ``execute_result``.
1020+
1021+
When a ``display_id`` is specified for a display, it can be updated later
1022+
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``.
10151024

10161025
Code inputs
10171026
-----------

0 commit comments

Comments
 (0)