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

docs: streamline 'timeout' / 'retry' docs in docstrings #461

Merged

Conversation

@tseaver
Copy link
Contributor

@tseaver tseaver commented Jun 8, 2021

  • Add 'requests' intersphinx refs.
  • Add narrative docs for timeouts and retries.
  • Replace boilerplate docs for 'timeout' and 'retry' in API-invoking methods with links to narrative docs.

Closes #455

@tseaver tseaver requested a review from as a code owner Jun 8, 2021
@google-cla google-cla bot added the cla: yes label Jun 8, 2021
owlbot.py Outdated Show resolved Hide resolved
@tseaver tseaver force-pushed the 455-move-boilerplate-timeout-retry-docs-from-docstrings branch from 0364999 to aa470b0 Jun 8, 2021
Copy link
Contributor

@tritone tritone left a comment

Thanks for adding this! A couple small suggestions.

docs/retry_timeout.rst Outdated Show resolved Hide resolved
docs/retry_timeout.rst Outdated Show resolved Hide resolved
@tritone
Copy link
Contributor

@tritone tritone commented Jun 9, 2021

Copy link
Contributor

@tritone tritone left a comment

Looks great!

docs/retry_timeout.rst Outdated Show resolved Hide resolved
docs/retry_timeout.rst Show resolved Hide resolved
docs/retry_timeout.rst Outdated Show resolved Hide resolved
docs/retry_timeout.rst Show resolved Hide resolved
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run label Jun 9, 2021
@tseaver tseaver requested a review from cojenco Jun 9, 2021
docs/retry_timeout.rst Show resolved Hide resolved
Copy link
Contributor

@cojenco cojenco left a comment

LGTM, thanks @tseaver for streamlining this!

tseaver and others added 10 commits Jun 10, 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.
Per review comments.
tseaver added 2 commits Jun 10, 2021
Further review comments.
@tseaver tseaver force-pushed the 455-move-boilerplate-timeout-retry-docs-from-docstrings branch from 435c4e4 to 1a56e89 Jun 10, 2021
@tseaver tseaver merged commit 78b2eba into master Jun 10, 2021
6 checks passed
@tseaver tseaver deleted the 455-move-boilerplate-timeout-retry-docs-from-docstrings branch Jun 10, 2021
cojenco added a commit to cojenco/python-storage that referenced this issue 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 added a commit to cojenco/python-storage that referenced this issue 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

5 participants