Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify that PollingFuture timeout is in seconds. #4201

Merged
merged 1 commit into from
Oct 16, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions core/google/api/core/future/polling.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ def _blocking_poll(self, timeout=None):
"""Poll and wait for the Future to be resolved.

Args:
timeout (int): How long to wait for the operation to complete.
timeout (int):
How long (in seconds) to wait for the operation to complete.
If None, wait indefinitely.
"""
if self._result_set:
Expand All @@ -91,7 +92,8 @@ def result(self, timeout=None):
"""Get the result of the operation, blocking if necessary.

Args:
timeout (int): How long to wait for the operation to complete.
timeout (int):
How long (in seconds) to wait for the operation to complete.
If None, wait indefinitely.

Returns:
Expand Down