jupyter / jupyter_client

Jupyter protocol client APIs
https://jupyter-client.readthedocs.io
BSD 3-Clause "New" or "Revised" License
381 stars 281 forks source link

Spec for execute_result doesn't mention transient field #305

Open takluyver opened 6 years ago

takluyver commented 6 years ago

The spec for execute_result messages says:

These are identical to display_data messages, with the addition of an execution_count key.

However, display_data has an optional transient field, which is not mentioned in the description of execute_result. Is it allowed there? Or is that field only for display_data and update_display_data?

rgbkrk commented 6 years ago

execute_result should be able to have the transient field, though I don’t know of a direct way to use it in ipython (especially for setting a display id)

minrk commented 6 years ago

yeah, the "identical to display_data" statement should take precedence, since it is the definition as opposed to the description. I just didn't copy the transient part when updating everything else.

takluyver commented 6 years ago

Thanks. I'm just updating jupyter_kernel_test to validate messages more strictly.