Skip to content
This repository was archived by the owner on Mar 31, 2026. It is now read-only.

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

Merged
tseaver merged 12 commits into
masterfrom
455-move-boilerplate-timeout-retry-docs-from-docstrings
Jun 10, 2021
Merged

docs: streamline 'timeout' / 'retry' docs in docstrings#461
tseaver merged 12 commits into
masterfrom
455-move-boilerplate-timeout-retry-docs-from-docstrings

Conversation

@tseaver

@tseavertseaver commented Jun 8, 2021

Copy link
Copy Markdown
Contributor
  • 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 a team, andrewsg, chrisrossi, frankyn and tritoneJune 8, 2021 21:25
@product-auto-labelproduct-auto-labelBot added the api: storage Issues related to the googleapis/python-storage API. label Jun 8, 2021
@google-clagoogle-claBot 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
Comment threadowlbot.py Outdated
@tseaver
tseaverforce-pushed the 455-move-boilerplate-timeout-retry-docs-from-docstrings branch from 0364999 to aa470b0CompareJune 8, 2021 22:49
tritone
tritone reviewed Jun 9, 2021
View reviewed changes

@tritonetritone left a comment

Copy link
Copy Markdown
Contributor

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.

Comment threaddocs/retry_timeout.rst Outdated
Comment threaddocs/retry_timeout.rst Outdated
@tritone

tritone commented Jun 9, 2021

Copy link
Copy Markdown
Contributor

@andrewsg@cojenco PTAL

tritone
tritone reviewed Jun 9, 2021
View reviewed changes

@tritonetritone left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks great!

Comment threaddocs/retry_timeout.rst Outdated
Comment threaddocs/retry_timeout.rst
cojenco
cojenco reviewed Jun 9, 2021
View reviewed changes
Comment threaddocs/retry_timeout.rst Outdated
cojenco
cojenco reviewed Jun 9, 2021
View reviewed changes
Comment threaddocs/retry_timeout.rst
@partheaparthea added the owlbot:run Add this label to trigger the Owlbot post processor. label Jun 9, 2021
@gcf-owl-botgcf-owl-botBot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jun 9, 2021
@tseaver
tseaver requested a review from cojencoJune 9, 2021 21:42
cojenco
cojenco reviewed Jun 10, 2021
View reviewed changes
Comment threaddocs/retry_timeout.rst
cojenco
cojenco approved these changes Jun 10, 2021
View reviewed changes

@cojencocojenco left a comment

Copy link
Copy Markdown
Contributor

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!

tseaverand 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
tseaverforce-pushed the 455-move-boilerplate-timeout-retry-docs-from-docstrings branch from 435c4e4 to 1a56e89CompareJune 10, 2021 15:32
@tseaver
tseaver merged commit 78b2eba into masterJun 10, 2021
@tseaver
tseaver deleted the 455-move-boilerplate-timeout-retry-docs-from-docstrings branch June 10, 2021 16:34
@tseavertseaver mentioned this pull request Jun 11, 2021
Merged
@tseavertseaver 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.
Closesgoogleapis#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.
Closesgoogleapis#455.
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@chrisrossichrisrossiAwaiting requested review from chrisrossi
@andrewsgandrewsgAwaiting requested review from andrewsg
@frankynfrankynAwaiting requested review from frankyn
3 more reviewers
@tritonetritonetritone left review comments
@busunkim96busunkim96busunkim96 left review comments
@cojencocojencocojenco approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

api: storageIssues related to the googleapis/python-storage API.cla: yesThis 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