added comment to clarify timeouts

Author: daniel-sanche

google/api_core/retry/retry_streaming.py

@@ -280,6 +280,8 @@ def on_error(e):
         maximum (float): The maximum amount of time to delay in seconds.
         multiplier (float): The multiplier applied to the delay.
         timeout (float): How long to keep retrying, in seconds.
+            Note: timeout is only checked before initiating a retry, so the target may
+            run past the timeout value as long as it is healthy.
         on_error (Callable[Exception]): A function to call while processing
             a retryable exception. Any error raised by this function will
             *not* be caught.

google/api_core/retry/retry_streaming_async.py

@@ -265,6 +265,8 @@ def on_error(e):
         maximum (float): The maximum amount of time to delay in seconds.
         multiplier (float): The multiplier applied to the delay.
         timeout (Optional[float]): How long to keep retrying in seconds.
+            Note: timeout is only checked before initiating a retry, so the target may
+            run past the timeout value as long as it is healthy.
         on_error (Optional[Callable[Exception]]): A function to call while processing
             a retryable exception. Any error raised by this function will
             *not* be caught.

google/api_core/retry/retry_unary.py

@@ -108,6 +108,8 @@ def retry_target(
         sleep_generator (Iterable[float]): An infinite iterator that determines
             how long to sleep between retries.
         timeout (Optional[float]): How long to keep retrying the target.
+            Note: timeout is only checked before initiating a retry, so the target may
+            run past the timeout value as long as it is healthy.
         on_error (Optional[Callable[Exception]]): If given, the on_error
             callback will be called with each retryable exception raised by the
             target. Any error raised by this function will *not* be caught.
@@ -250,6 +252,8 @@ class Retry(_BaseRetry):
         maximum (float): The maximum amount of time to delay in seconds.
         multiplier (float): The multiplier applied to the delay.
         timeout (float): How long to keep retrying, in seconds.
+            Note: timeout is only checked before initiating a retry, so the target may
+            run past the timeout value as long as it is healthy.
         on_error (Callable[Exception]): A function to call while processing
             a retryable exception. Any error raised by this function will
             *not* be caught.

google/api_core/retry/retry_unary_async.py

@@ -118,6 +118,8 @@ async def retry_target(
         sleep_generator (Iterable[float]): An infinite iterator that determines
             how long to sleep between retries.
         timeout (Optional[float]): How long to keep retrying the target, in seconds.
+            Note: timeout is only checked before initiating a retry, so the target may
+            run past the timeout value as long as it is healthy.
         on_error (Optional[Callable[Exception]]): If given, the on_error
             callback will be called with each retryable exception raised by the
             target. Any error raised by this function will *not* be caught.
@@ -187,6 +189,8 @@ class AsyncRetry(_BaseRetry):
         maximum (float): The maximum amount of time to delay in seconds.
         multiplier (float): The multiplier applied to the delay.
         timeout (Optional[float]): How long to keep retrying in seconds.
+            Note: timeout is only checked before initiating a retry, so the target may
+            run past the timeout value as long as it is healthy.
         on_error (Optional[Callable[Exception]]): A function to call while processing
             a retryable exception. Any error raised by this function will
             *not* be caught.