Skip to content

Commit c1b85ea

Browse files
authored
Merge pull request #500 from vatlab/master
Document the handling of error in do_execute
2 parents 650fd75 + dfeefb3 commit c1b85ea

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/wrapperkernels.rst

+4-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,10 @@ following methods and attributes:
6363

6464
Your method should return a dict containing the fields described in
6565
:ref:`execution_results`. To display output, it can send messages
66-
using :meth:`~ipykernel.kernelbase.Kernel.send_response`.
66+
using :meth:`~ipykernel.kernelbase.Kernel.send_response`. If an error
67+
occurs during execution, an message of type `error` should be sent
68+
through :meth:`~ipykernel.kernelbase.Kernel.send_response`
69+
in addition to an :ref:`execution_results` with an `status` of `error`.
6770
See :doc:`messaging` for details of the different message types.
6871

6972
.. automethod:: ipykernel.kernelbase.Kernel.send_response

0 commit comments

Comments
 (0)