Skip to content

Commit 4776d31

Browse files
committed
Include notes about 5.1 version changes and additions
1 parent f5468c7 commit 4776d31

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/messaging.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -967,8 +967,9 @@ Message type: ``display_data``::
967967
# Any metadata that describes the data
968968
'metadata' : dict,
969969

970-
# Optional transient data. Information not to be persisted to a notebook
971-
# or other documents. Intended to live only during a live kernel session.
970+
# Optional transient data introduced in 5.1. Information not to be
971+
# persisted to a notebook or other documents. Intended to live only
972+
# during a live kernel session.
972973
'transient': dict,
973974
}
974975

@@ -1012,9 +1013,15 @@ document formats and is fully optional. The only transient key currently defined
10121013
`application/json` data should be unpacked JSON data,
10131014
not double-serialized as a JSON string.
10141015

1016+
.. versionchanged:: 5.1
1017+
1018+
`transient` is a new field.
1019+
10151020
Update Display Data
10161021
-------------------
10171022

1023+
.. versionadded:: 5.1
1024+
10181025
Displays can now be named with a ``display_id`` within the ``transient`` field of
10191026
``display_data`` or ``execute_result``.
10201027

0 commit comments

Comments
 (0)