Skip to content

Commit 2fd2d59

Browse files
committed
transient data is an optional key on displays
1 parent bd2b0ea commit 2fd2d59

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/messaging.rst

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

970-
# Any information not to be persisted to a notebook or other environment
971-
# Intended to live only during a kernel session
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.
972972
'transient': dict
973973
}
974974

@@ -1000,7 +1000,7 @@ and expanded for JSON data::
10001000

10011001

10021002
The ``transient`` dict contains runtime metadata that should not be persisted to
1003-
document formats. The only transient key currently defined in Jupyter is
1003+
document formats and is fully optional. The only transient key currently defined in Jupyter is
10041004
``display_id``::
10051005

10061006
transient = {

0 commit comments

Comments
 (0)