From c9dcdf65d5878eb70d9ba6b1cae9d5e224ed4dcd Mon Sep 17 00:00:00 2001 From: Min RK Date: Tue, 8 Mar 2016 09:47:49 +0100 Subject: [PATCH] add note about displaying metadata --- notebook-diff/notebook-diff.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/notebook-diff/notebook-diff.md b/notebook-diff/notebook-diff.md index 1064b8d4..ebc7a38a 100644 --- a/notebook-diff/notebook-diff.md +++ b/notebook-diff/notebook-diff.md @@ -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.