From 655d63c2e8d53b72b20c1cb338890e591ddf89ea 2015-01-24 20:08:29 From: Min RK Date: 2015-01-24 20:08:29 Subject: [PATCH] describe what constitutes a minor revision to nbformat --- diff --git a/docs/source/notebook/nbformat.rst b/docs/source/notebook/nbformat.rst index 2b37915..9cb619a 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 ========