add comment

jupyter · May 13, 2024 · 926ae73 · 926ae73
1 parent 3733b2f
commit 926ae73
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/nbclient/client.py b/nbclient/client.py
@@ -772,8 +772,9 @@ async def _async_poll_for_reply(
             deadline = monotonic() + timeout
             new_timeout = float(timeout)
         else:
-            # if we set new_timeout None value , and pass to the function of shell_channel.get_msg, will sometimes
-            # blocking so need pass a timeout value, and reset the value when timeout value exhausted
+            # if we call shell_channel.get_msg with None timeout value, sometimes will
+            # block current execution forever so need pass a timeout value, so we
+            # need give a default value and reset the value when timeout value exhausted
             deadline = monotonic() + 5
             new_timeout = float(5)
         error_on_timeout_execute_reply = None