From 5496010f0c608d018ee3dd552cc6f34bcf1575cb Mon Sep 17 00:00:00 2001 From: Min RK Date: Fri, 23 Jan 2015 15:38:08 -0800 Subject: [PATCH] describe what constitutes a minor revision to nbformat --- docs/source/notebook/nbformat.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/source/notebook/nbformat.rst b/docs/source/notebook/nbformat.rst index 2b37915cf..9cb619a92 100644 --- a/docs/source/notebook/nbformat.rst +++ b/docs/source/notebook/nbformat.rst @@ -291,6 +291,22 @@ regardless of format. "source" : ["some nbformat mime-type data"] } +Backwared-compatible changes +============================ + +The notebook format is an evolving format. When backward-compatible changes are made, +the notebook format minor version is incremented. When backward-incompatible changes are made, +the major version is incremented. + +As of nbformat 4.x, backward-compatible changes include: + +- new fields in any cell or output or metadata +- new cell types +- new output types + +New cell or output types will not be rendered in versions that do not recognize them, +but they will be preserved. + Metadata ========