Browse Source

Add comment about timeout argument

Richard Belleville 5 years ago
parent
commit
9b24faf188
1 changed files with 9 additions and 0 deletions
  1. 9 0
      src/python/grpcio/grpc/_channel.py

+ 9 - 0
src/python/grpcio/grpc/_channel.py

@@ -476,6 +476,9 @@ class _SingleThreadedRendezvous(_Rendezvous, grpc.Call, grpc.Future):  # pylint:
 
 
         This method will never block. Instead, it will raise an exception
         This method will never block. Instead, it will raise an exception
         if calling this method would otherwise result in blocking.
         if calling this method would otherwise result in blocking.
+
+        Since this method will never block, any `timeout` argument passed will
+        be ignored.
         """
         """
         del timeout
         del timeout
         with self._state.condition:
         with self._state.condition:
@@ -495,6 +498,9 @@ class _SingleThreadedRendezvous(_Rendezvous, grpc.Call, grpc.Future):  # pylint:
 
 
         This method will never block. Instead, it will raise an exception
         This method will never block. Instead, it will raise an exception
         if calling this method would otherwise result in blocking.
         if calling this method would otherwise result in blocking.
+
+        Since this method will never block, any `timeout` argument passed will
+        be ignored.
         """
         """
         del timeout
         del timeout
         with self._state.condition:
         with self._state.condition:
@@ -514,6 +520,9 @@ class _SingleThreadedRendezvous(_Rendezvous, grpc.Call, grpc.Future):  # pylint:
 
 
         This method will never block. Instead, it will raise an exception
         This method will never block. Instead, it will raise an exception
         if calling this method would otherwise result in blocking.
         if calling this method would otherwise result in blocking.
+
+        Since this method will never block, any `timeout` argument passed will
+        be ignored.
         """
         """
         del timeout
         del timeout
         with self._state.condition:
         with self._state.condition: