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

add note about displaying metadata #2

Merged
merged 1 commit into from
Mar 8, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions notebook-diff/notebook-diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,19 @@ behaviour of the multilevel approach must be investigated further and
other approaches could be considered..


### Displaying metadata diffs

The notebook format has metadata in various locations,
including on each cell, output, and top-level on the notebook.
These are dictionaries with potentially arbitrary JSON content.
Computing metadata diffs is not different from any other dictionary diff.
However, metadata generally does not have a visual representation in the live notebook,
but it must be indicated in the diff view if there are changes.
We will explore various represenentations of metadata changes in the notebook view.
The most primitive would be to display the raw dictionary diff as a JSON field in the notebook view,
near the displayable item the metadata is associated with.


### Note about the potential addition of a "move" transformation

In the current implementation there is no "move" operation.
Expand Down