Skip to content

Commit 7ea2c63

Browse files
author
Martin Sandve Alnæs
committed
Merge pull request #2 from minrk/nbdiff
add note about displaying metadata
2 parents 48dea94 + c9dcdf6 commit 7ea2c63

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

notebook-diff/notebook-diff.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,19 @@ behaviour of the multilevel approach must be investigated further and
217217
other approaches could be considered..
218218

219219

220+
### Displaying metadata diffs
221+
222+
The notebook format has metadata in various locations,
223+
including on each cell, output, and top-level on the notebook.
224+
These are dictionaries with potentially arbitrary JSON content.
225+
Computing metadata diffs is not different from any other dictionary diff.
226+
However, metadata generally does not have a visual representation in the live notebook,
227+
but it must be indicated in the diff view if there are changes.
228+
We will explore various represenentations of metadata changes in the notebook view.
229+
The most primitive would be to display the raw dictionary diff as a JSON field in the notebook view,
230+
near the displayable item the metadata is associated with.
231+
232+
220233
### Note about the potential addition of a "move" transformation
221234

222235
In the current implementation there is no "move" operation.

0 commit comments

Comments
 (0)