Skip to content

Commit

Permalink
Merge pull request #2 from minrk/nbdiff
Browse files Browse the repository at this point in the history
add note about displaying metadata
  • Loading branch information
Martin Sandve Alnæs committed Mar 8, 2016
2 parents 48dea94 + c9dcdf6 commit 7ea2c63
Showing 1 changed file with 13 additions and 0 deletions.
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

0 comments on commit 7ea2c63

Please sign in to comment.