This repository was archived by the owner on Mar 31, 2026. It is now read-only.
Repository navigation
This repository was archived by the owner on Mar 31, 2026. It is now read-only.
Move boilerplate docs for 'timeout' and 'retry' out of method docstrings #455
Description
The repeted long-form docs for the timeout and retry arguments to all API-invoking methods are both too verbose and too terse: they don't include / reference examples, and they are wordy. By preference, they would point instead to a narrative page (built from e.g. docs/timeout_retry.rst) which would include comprehensive examples for them.
Activity
tseaver commentedon Jun 7, 2021
Note to self: there is tons of boilerplate for the "conditional" arguments (
if_generation_match, etc.) scattered in the code. We should likely create a separate narrative docs page for them, as well, and replace the boilerplate in docstrings with links to its sections. Opened #460 to track that issue.docs: streamline 'timeout' / 'retry docstrngs
docs: streamline 'timeout' / 'retry docstrngs
docs: streamline 'timeout' / 'retry' docs in docstrings (#461)
docs: streamline 'timeout' / 'retry' docs in docstrings (googleapis#461)
docs: streamline 'timeout' / 'retry' docs in docstrings (googleapis#461)