Skip to content

Commit fbdd296

Browse files
committed
autodoc execute_interactive
add to BlockingKernelClient docstring
1 parent 59ebd3a commit fbdd296

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

docs/api/client.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,7 @@ client - communicating with kernels
3737
.. automethod:: get_iopub_msg
3838

3939
.. automethod:: get_stdin_msg
40+
41+
.. autoclass:: BlockingKernelClient
42+
43+
.. automethod:: execute_interactive

jupyter_client/blocking/client.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,11 @@ def wrapped(self, *args, **kwargs):
7070
return wrapped
7171

7272
class BlockingKernelClient(KernelClient):
73-
"""A BlockingKernelClient """
73+
"""A KernelClient with blocking APIs
74+
75+
``get_[channel]_msg()`` methods wait for and return messages on channels,
76+
raising :exc:`queue.Empty` if no message arrives within ``timeout`` seconds.
77+
"""
7478

7579
def wait_for_ready(self, timeout=None):
7680
"""Waits for a response when a client is blocked
@@ -213,6 +217,8 @@ def execute_interactive(self, code, silent=False, store_history=True,
213217
You can pass a custom output_hook callable that will be called
214218
with every IOPub message that is produced instead of the default redisplay.
215219
220+
.. versionadded:: 5.0
221+
216222
Parameters
217223
----------
218224
code : str

0 commit comments

Comments
 (0)