Skip to content

Commit

Permalink
Added missing cell execution docs for new schema
Browse files Browse the repository at this point in the history
  • Loading branch information
MSeal committed Jan 6, 2020
1 parent cfb7cbd commit 49415b9
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/format_description.rst
Original file line number Diff line number Diff line change
Expand Up @@ -408,6 +408,19 @@ source_hidden bool Whether the cell's source should be shown
outputs_hidden bool Whether the cell's outputs should be shown
=============== =============== ==============

The following metadata keys are defined at the cell level within the `execution` namespace.
These are lower level fields capturing common kernel message timestamps for better visibility
in applications where needed. Most users will not look at these directly.

==================== ================ ==============
Key Value Interpretation
==================== ================ ==============
iopub.execute_input ISO 8601 format Indicates the time at which the kernel broadcast an execute_input message. This represents the time when request for work was received by the kernel.
iopub.status.busy ISO 8601 format Indicates the time at which the iopub channel's kernel status message is 'busy'. This represents the time when work was started by the kernel.
shell.execute_reply ISO 8601 format Indicates the time at which the shell channel's execute_reply status message was created. This represents the time when work was completed by the kernel.
iopub.status.idle ISO 8601 format Indicates the time at which the iopub channel's kernel status message is 'idle'. This represents the time when the kernel is ready to accept new work.
==================== ================ ==============

Output metadata
---------------

Expand Down

0 comments on commit 49415b9

Please sign in to comment.