From b23cd3d38e490313e6be3e3aaf9b9cc31d263edb Mon Sep 17 00:00:00 2001 From: Min RK Date: Fri, 23 Jan 2015 15:37:51 -0800 Subject: [PATCH 1/3] fix stream output specification in nbformat doc --- docs/source/notebook/nbformat.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/notebook/nbformat.rst b/docs/source/notebook/nbformat.rst index b2ee31fa5..2b37915cf 100644 --- a/docs/source/notebook/nbformat.rst +++ b/docs/source/notebook/nbformat.rst @@ -150,13 +150,13 @@ stream output { "output_type" : "stream", "name" : "stdout", # or stderr - "data" : ["multiline stream text"], + "text" : ["multiline stream text"], } .. versionchanged:: nbformat 4.0 - The keys ``stream`` and ``text`` were changed to ``name`` and ``data`` to match - the stream message specification. + The keys ``stream`` key was changed to ``name`` to match + the stream message. display_data From 5496010f0c608d018ee3dd552cc6f34bcf1575cb Mon Sep 17 00:00:00 2001 From: Min RK Date: Fri, 23 Jan 2015 15:38:08 -0800 Subject: [PATCH 2/3] 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 ======== From a380ccaec262e8c86a80be3e21dd2335d19b178a Mon Sep 17 00:00:00 2001 From: Min RK Date: Sat, 24 Jan 2015 12:10:09 -0800 Subject: [PATCH 3/3] all new fields are backward-compatible not just on cells, outputs, metadata --- docs/source/notebook/nbformat.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/notebook/nbformat.rst b/docs/source/notebook/nbformat.rst index 9cb619a92..115e7726b 100644 --- a/docs/source/notebook/nbformat.rst +++ b/docs/source/notebook/nbformat.rst @@ -291,8 +291,8 @@ regardless of format. "source" : ["some nbformat mime-type data"] } -Backwared-compatible changes -============================ +Backward-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, @@ -300,7 +300,7 @@ the major version is incremented. As of nbformat 4.x, backward-compatible changes include: -- new fields in any cell or output or metadata +- new fields in any dictionary (notebook, cell, output, metadata, etc.) - new cell types - new output types