Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updatable Displays #225

Merged
merged 7 commits into from
Nov 15, 2016
Merged

Updatable Displays #225

merged 7 commits into from
Nov 15, 2016

Conversation

rgbkrk
Copy link
Member

@rgbkrk rgbkrk commented Nov 14, 2016

The protocol updates for #209, updateable displays.

  • Declare transient field
  • Describe display_id intent
  • Describe the update display data more fully, what it means for kernels and frontend authors

@rgbkrk rgbkrk changed the title [WIP] Update Display Data Update Display Data Nov 14, 2016
@rgbkrk rgbkrk changed the title Update Display Data Updatable Displays Nov 14, 2016
@blink1073
Copy link
Contributor

Should transient be declared an optional field?

@blink1073
Copy link
Contributor

(For display and execute_result, not the new message type).

@rgbkrk
Copy link
Member Author

rgbkrk commented Nov 14, 2016

Should transient be declared an optional field?

Ah yes, that's important.

``display_data`` or ``execute_result``.

When a ``display_id`` is specified for a display, it can be updated later
with an ``update_display_data`` message. This message has the same format as `display_data`_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Double check the '`' and triple backticks in this line and the next. Looks like some typos.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, that's my complete markdown bias showing. I've completely forgotten how to write restructured text.

'data' : dict,

# Any metadata that describes the data
'metadata' : dict
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Trailing comma?


# Any information not to be persisted to a notebook or other environment
# Intended to live only during a kernel session
'transient': dict
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Trailing comma?

Copy link
Member

@willingc willingc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for the fixes.

@rgbkrk
Copy link
Member Author

rgbkrk commented Nov 15, 2016

This is good to go and/or have some more review.

Update Display Data
-------------------

Displays can now be named with a ``display_id`` within the ``transient`` field of
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add .. versionadded:: 5.1 here?

transient = {
'display_id': 'abcd'
}

.. versionchanged:: 5.0

`application/json` data should be unpacked JSON data,
not double-serialized as a JSON string.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add .. versionchanged:: 5.1 note for when transient will arrive

@minrk minrk added this to the 4.5 milestone Nov 15, 2016
@rgbkrk
Copy link
Member Author

rgbkrk commented Nov 15, 2016

@minrk Thanks, updated!

@minrk minrk merged commit 7c5c013 into jupyter:master Nov 15, 2016
@minrk
Copy link
Member

minrk commented Nov 15, 2016

Thanks!

@rgbkrk rgbkrk deleted the update-display-data branch November 15, 2016 21:33
@minrk minrk modified the milestones: 4.5, 5.0 Feb 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants