From 4589485a2ba1c284a1c43f9f7e96d4700e4c2aa2 Mon Sep 17 00:00:00 2001 From: Lidi Zheng Date: Tue, 28 Apr 2020 11:38:48 -0700 Subject: [PATCH] Add docs generation --- docs/retry.rst | 7 +++++++ google/api_core/retry_async.py | 6 +++--- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/retry.rst b/docs/retry.rst index 23a7d70f3..97a7f2ca0 100644 --- a/docs/retry.rst +++ b/docs/retry.rst @@ -4,3 +4,10 @@ Retry .. automodule:: google.api_core.retry :members: :show-inheritance: + +Retry in AsyncIO +---------------- + +.. automodule:: google.api_core.retry_async + :members: + :show-inheritance: diff --git a/google/api_core/retry_async.py b/google/api_core/retry_async.py index 52b4d39bb..5d78f26e2 100644 --- a/google/api_core/retry_async.py +++ b/google/api_core/retry_async.py @@ -222,7 +222,7 @@ def with_deadline(self, deadline): deadline (float): How long to keep retrying. Returns: - Retry: A new retry instance with the given deadline. + AsyncRetry: A new retry instance with the given deadline. """ return AsyncRetry( predicate=self._predicate, @@ -241,7 +241,7 @@ def with_predicate(self, predicate): ``True`` if the given exception is retryable. Returns: - Retry: A new retry instance with the given predicate. + AsyncRetry: A new retry instance with the given predicate. """ return AsyncRetry( predicate=predicate, @@ -262,7 +262,7 @@ def with_delay(self, initial=None, maximum=None, multiplier=None): multiplier (float): The multiplier applied to the delay. Returns: - Retry: A new retry instance with the given predicate. + AsyncRetry: A new retry instance with the given predicate. """ return AsyncRetry( predicate=self._predicate,