docs: streamline 'timeout' / 'retry' docs in docstrings by tseaver · Pull Request #461

docs: streamline 'timeout' / 'retry' docs in docstrings by tseaver · Pull Request #461 · googleapis/python-storage

This human has signed the Contributor License Agreement.

label

Jun 8, 2021

Include API docs for the 'retry' module, as well, to unbreak links.

Replace boilerplate with links to new narrative docs.

Closes #455.

Rather than hacking it in via replacement.

- Explain semantics of default policies, and where used.

- Provide an example of a predicate function for a conditional policy.

Per review comments.

tseaver deleted the 455-move-boilerplate-timeout-retry-docs-from-docstrings branch

June 10, 2021 16:34

cojenco pushed a commit to cojenco/python-storage that referenced this pull request

Oct 13, 2021

* Add 'requests' intersphinx refs
* Add narrative docs for timeouts and retries
* Include API docs for the 'retry' module, as well, to unbreak links.
* Replace boilerplate docstring entries for 'timeout' / 'retry' with links to new narrative docs.
* Add docstrings for default conditional policies.

Closes googleapis#455.

cojenco pushed a commit to cojenco/python-storage that referenced this pull request

Oct 13, 2021

* Add 'requests' intersphinx refs
* Add narrative docs for timeouts and retries
* Include API docs for the 'retry' module, as well, to unbreak links.
* Replace boilerplate docstring entries for 'timeout' / 'retry' with links to new narrative docs.
* Add docstrings for default conditional policies.

Closes googleapis#455.