Merge pull request #4979 from minrk/clear-output-msgspec

add versioning notes to small message spec changes

IPython/core/release.py

@@ -39,7 +39,7 b' version = __version__ # backwards compatibility name'
 version_info = (_version_major, _version_minor, _version_patch, _version_extra)
 
 # Change this when incrementing the kernel protocol version
-kernel_protocol_version_info = (4, 0)
+kernel_protocol_version_info = (4, 1)
 
 description = "IPython: Productive Interactive Computing"
 

IPython/html/static/notebook/js/outputarea.js

@@ -743,7 +743,12 b' var IPython = (function (IPython) {'
 
 
     OutputArea.prototype.handle_clear_output = function (msg) {
-        this.clear_output(msg.content.wait);
+        // msg spec v4 had stdout, stderr, display keys
+        // v4.1 replaced these with just wait
+        // The default behavior is the same (stdout=stderr=display=True, wait=False),
+        // so v4 messages will still be properly handled,
+        // except for the rarely used clearing less than all output.
+        this.clear_output(msg.content.wait || false);
     };
 
 

docs/source/development/messaging.rst

@@ -5,6 +5,13 b''
 ======================
 
 
+Versioning
+==========
+
+The IPython message specification is versioned independently of IPython.
+The current version of the specification is 4.1.
+
+
 Introduction
 ============
 
@@ -1001,6 +1008,14 b' Message type: ``clear_output``::'
         'wait' : bool,
     }
 
+.. versionchanged:: 4.1
+
+    'stdout', 'stderr', and 'display' boolean keys for selective clearing are removed,
+    and 'wait' is added.
+    The selective clearing keys are ignored in v4 and the default behavior remains the same,
+    so v4 clear_output messages will be safely handled by a v4.1 frontend.
+
+
 Messages on the stdin ROUTER/DEALER sockets
 ===========================================
 
@@ -1071,7 +1086,9 b" access to the message between the monitor's send, and the monitor's recv."
 Custom Messages
 ===============
 
-IPython 2.0 adds a messaging system for developers to add their own objects with Frontend
+.. versionadded:: 4.1
+
+IPython 2.0 (msgspec v4.1) adds a messaging system for developers to add their own objects with Frontend
 and Kernel-side components, and allow them to communicate with each other.
 To do this, IPython adds a notion of a ``Comm``, which exists on both sides,
 and can communicate in either direction.
@@ -1081,8 +1098,6 b' and no messages expect a reply.'
 The Kernel listens for these messages on the Shell channel,
 and the Frontend listens for them on the IOPub channel.
 
-.. versionadded:: 2.0
-
 Opening a Comm
 --------------