Skip to content

Commit 7caed53

Browse files
committed
Declare the transient dict
1 parent 5d54fe3 commit 7caed53

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/messaging.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -966,6 +966,10 @@ Message type: ``display_data``::
966966

967967
# Any metadata that describes the data
968968
'metadata' : dict
969+
970+
# Any information not to be persisted to a notebook or other environment
971+
# Intended to live only during a kernel session
972+
'transient': dict
969973
}
970974

971975

@@ -994,12 +998,20 @@ and expanded for JSON data::
994998
}
995999
}
9961000

1001+
1002+
The ``transient`` dict contains runtime metadata that should not be persisted to
1003+
document formats. The first field used in transient is `display_id`.
1004+
9971005
.. versionchanged:: 5.0
9981006

9991007
`application/json` data should be unpacked JSON data,
10001008
not double-serialized as a JSON string.
10011009

1010+
Update Display Data
1011+
-------------------
10021012

1013+
This message has the same format as `display_data`_ messages and must contain
1014+
a ```transient`` field with a ``display_id``.
10031015

10041016
Code inputs
10051017
-----------

0 commit comments

Comments
 (0)