Merge pull request #500 from vatlab/master

Document the handling of error in do_execute
jupyter · Feb 4, 2020 · c1b85ea · c1b85ea
2 parents 650fd75 + dfeefb3
commit c1b85ea
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/docs/wrapperkernels.rst b/docs/wrapperkernels.rst
@@ -63,7 +63,10 @@ following methods and attributes:
 
      Your method should return a dict containing the fields described in
      :ref:`execution_results`. To display output, it can send messages
-     using :meth:`~ipykernel.kernelbase.Kernel.send_response`.
+     using :meth:`~ipykernel.kernelbase.Kernel.send_response`. If an error
+     occurs during execution, an message of type `error` should be sent
+     through :meth:`~ipykernel.kernelbase.Kernel.send_response`
+     in addition to an :ref:`execution_results` with an `status` of `error`.
      See :doc:`messaging` for details of the different message types.
 
 .. automethod:: ipykernel.kernelbase.Kernel.send_response