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

Jump to bottom

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

Merged
merged 12 commits into from Jun 10, 2021
Merged

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

merged 12 commits into from Jun 10, 2021

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 review from chrisrossi, andrewsg, frankyn, tritone and a team June 8, 2021 21:25
@tseaver tseaver requested a review from a team as a code owner June 8, 2021 21:25
@product-auto-label product-auto-label bot added the api: storage Issues related to the googleapis/python-storage API. label Jun 8, 2021
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Jun 8, 2021
tseaver
tseaver commented Jun 8, 2021
View reviewed changes
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 Compare June 8, 2021 22:49
tritone
tritone reviewed Jun 9, 2021
View reviewed changes
Copy link
Contributor

@tritone tritone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 commented Jun 9, 2021

@andrewsg @cojenco PTAL

tritone
tritone reviewed Jun 9, 2021
View reviewed changes
Copy link
Contributor

@tritone tritone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

docs/retry_timeout.rst Outdated Show resolved Hide resolved
docs/retry_timeout.rst Show resolved Hide resolved
cojenco
cojenco reviewed Jun 9, 2021
View reviewed changes
docs/retry_timeout.rst Outdated Show resolved Hide resolved
@parthea parthea added the owlbot:run Add this label to trigger the Owlbot post processor. label Jun 9, 2021
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jun 9, 2021
@tseaver tseaver requested a review from cojenco June 9, 2021 21:42
cojenco
cojenco approved these changes Jun 10, 2021
View reviewed changes
Copy link
Contributor

@cojenco cojenco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @tseaver for streamlining this!

tseaver and others added 10 commits June 10, 2021 11:32
@tseaver
docs: add 'requests' intersphinx refs
475d1fb
@tseaver
docs: add narrative docs for timeouts and retries
6de23df 
Include API docs for the 'retry' module, as well, to unbreak links.
@tseaver
docs: streamline 'timeout' / 'retry docstrngs
7c6d4ca 
Replace boilerplate with links to new narrative docs.

Closes #455.
@tseaver
fix: appease regex matching idols
581a43c
@tseaver
fix: fail owlbot if replacement misses
a9014aa
@tseaver
fix: add 'requests' intersphinx dep via library API
bcecbaf 
Rather than hacking it in via replacement.
@tseaver
docs: add docstrings for default conditional policies.
501bb17
@tseaver
docs: flesh out retry docs
99f38cd 
- Explain semantics of default policies, and where used.

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

Per review comments.
@gcf-owl-bot @tseaver
🦉 Updates from OwlBot
2162c28
@tseaver
docs: tweak
4b1f419 
Per review comments.
@tseaver tseaver force-pushed the 455-move-boilerplate-timeout-retry-docs-from-docstrings branch from 435c4e4 to 1a56e89 Compare June 10, 2021 15:32
@tseaver tseaver merged commit 78b2eba into master Jun 10, 2021
@tseaver tseaver deleted the 455-move-boilerplate-timeout-retry-docs-from-docstrings branch June 10, 2021 16:34
@tseaver tseaver mentioned this pull request Jun 11, 2021
Merged
@tseaver tseaver mentioned this pull request Jun 21, 2021
Closed
cojenco pushed a commit to cojenco/python-storage that referenced this pull request Oct 13, 2021
@tseaver @cojenco
docs: streamline 'timeout' / 'retry' docs in docstrings (googleapis#461)
9503b08 
* 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
@tseaver @cojenco
docs: streamline 'timeout' / 'retry' docs in docstrings (googleapis#461)
97555fa 
* 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
Reviewers

@tritone tritone tritone left review comments

@busunkim96 busunkim96 busunkim96 left review comments

@cojenco cojenco cojenco approved these changes

@chrisrossi chrisrossi Awaiting requested review from chrisrossi

@andrewsg andrewsg Awaiting requested review from andrewsg

@frankyn frankyn Awaiting requested review from frankyn

Assignees
No one assigned
Labels
api: storage Issues related to the googleapis/python-storage API. cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Move boilerplate docs for 'timeout' and 'retry' out of method docstrings
5 participants
@tseaver @tritone @busunkim96 @cojenco @parthea