Client: add note about timeout sideeffects

m-labs · Feb 2, 2016 · c28b938 · c28b938
1 parent f7df393
commit c28b938
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/artiq/protocols/pc_rpc.py b/artiq/protocols/pc_rpc.py
@@ -95,7 +95,9 @@ class Client:
         (default), ``0`` for non-blocking, and a finite value to raise
         ``socket.timeout`` if an operation does not complete within the
         given time. See also ``socket.create_connection()`` and
-        ``socket.settimeout()`` in the Python standard library.
+        ``socket.settimeout()`` in the Python standard library. A timeout
+        in the middle of a RPC can break subsequent RPCs (from the same
+        client).
     """
     def __init__(self, host, port, target_name=AutoTarget, timeout=None):
         self.__socket = socket.create_connection((host, port), timeout)