##// END OF EJS Templates
Merge pull request #5008 from ivanov/messaging-doc...
Thomas Kluyver -
r15017:b3bfc778 merge
parent child Browse files
Show More
@@ -402,6 +402,8 b' the outcome. See :ref:`below <execution_results>` for the possible return'
402 402 codes and associated data.
403 403
404 404
405 .. _execution_counter:
406
405 407 Execution counter (old prompt number)
406 408 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
407 409
@@ -410,7 +412,7 b' requests that are made with ``store_history=True``. This counter is used to pop'
410 412 the ``In[n]``, ``Out[n]`` and ``_n`` variables, so clients will likely want to
411 413 display it in some form to the user, which will typically (but not necessarily)
412 414 be done in the prompts. The value of this counter will be returned as the
413 ``execution_count`` field of all ``execute_reply`` messages.
415 ``execution_count`` field of all ``execute_reply`` and ``pyin`` messages.
414 416
415 417 .. _execution_results:
416 418
@@ -832,12 +834,6 b' frontend to decide which to use and how. A single message should contain all'
832 834 possible representations of the same information. Each representation should
833 835 be a JSON'able data structure, and should be a valid MIME type.
834 836
835 Some questions remain about this design:
836
837 * Do we use this message type for pyout/displayhook? Probably not, because
838 the displayhook also has to handle the Out prompt display. On the other hand
839 we could put that information into the metadata section.
840
841 837 Message type: ``display_data``::
842 838
843 839 content = {
@@ -913,7 +909,10 b' to update a single namespace with subsequent results.'
913 909 Python inputs
914 910 -------------
915 911
916 These messages are the re-broadcast of the ``execute_request``.
912 To let all frontends know what code is being executed at any given time, these
913 messages contain a re-broadcast of the ``code`` portion of an
914 :ref:`execute_request <execute>`, along with the :ref:`execution_count
915 <execution_counter>`.
917 916
918 917 Message type: ``pyin``::
919 918
General Comments 0
You need to be logged in to leave comments. Login now