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: fix 'CallOptions' examples #6264

Merged
merged 2 commits into from
Oct 24, 2018
Merged

Docs: fix 'CallOptions' examples #6264

merged 2 commits into from
Oct 24, 2018

Conversation

tseaver
Copy link
Contributor

@tseaver tseaver commented Oct 18, 2018

In package README.rst files, where CallOptions was being shown as a way to trigger paged iteration, usse idiomatic pages attribute of iterators

For VisionHelper.annotate_image, update docstring to reflect the actual signature, which takes retry and timeout rather than options.

Closes #5560.

Other elements of that bug will be fixed in gapic-generator and propagated via autosynth.

Remove GAX-style 'options', use explicit 'retry' and 'timeout'.

Closes #5560.  (Other elements of that bug will be fixed in 'gapic-generator'
(see: googleapis/gapic-generator#2388) and
propagated via autosynth.
@tseaver tseaver added documentation api: vision Issues related to the Cloud Vision API. api: monitoring Issues related to the Cloud Monitoring API. api: dataproc Issues related to the Dataproc API. api: bigquerydatatransfer Issues related to the BigQuery Data Transfer Service API. api: cloudiot Issues related to the IoT Core API. labels Oct 18, 2018
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Oct 18, 2018
@JustinBeckwith JustinBeckwith added type: docs Improvement to the documentation for an API. and removed documentation labels Oct 18, 2018
@tseaver
Copy link
Contributor Author

tseaver commented Oct 24, 2018

Merging without review: this is a docs-only fix, where the current samples / docstrings are clearly borked.

@tseaver tseaver closed this Oct 24, 2018
@tseaver tseaver reopened this Oct 24, 2018
@tseaver tseaver merged commit d144a00 into googleapis:master Oct 24, 2018
@tseaver tseaver deleted the 5560-docs-fix_call_options_examples branch October 24, 2018 20:54
parthea pushed a commit that referenced this pull request Sep 22, 2023
* Remove GAX 'CallOptions' fossils from README examples.

* Fix out-of-date docstring for 'VisionHelpers.annotate_image'.

Remove GAX-style 'options', use explicit 'retry' and 'timeout'.

Closes #5560.  (Other elements of that bug will be fixed in 'gapic-generator'
(see: googleapis/gapic-generator#2388) and
propagated via autosynth.
parthea pushed a commit that referenced this pull request Sep 22, 2023
* Remove GAX 'CallOptions' fossils from README examples.

* Fix out-of-date docstring for 'VisionHelpers.annotate_image'.

Remove GAX-style 'options', use explicit 'retry' and 'timeout'.

Closes #5560.  (Other elements of that bug will be fixed in 'gapic-generator'
(see: googleapis/gapic-generator#2388) and
propagated via autosynth.
parthea pushed a commit that referenced this pull request Oct 21, 2023
* Remove GAX 'CallOptions' fossils from README examples.

* Fix out-of-date docstring for 'VisionHelpers.annotate_image'.

Remove GAX-style 'options', use explicit 'retry' and 'timeout'.

Closes #5560.  (Other elements of that bug will be fixed in 'gapic-generator'
(see: googleapis/gapic-generator#2388) and
propagated via autosynth.
parthea pushed a commit that referenced this pull request Oct 21, 2023
* Remove GAX 'CallOptions' fossils from README examples.

* Fix out-of-date docstring for 'VisionHelpers.annotate_image'.

Remove GAX-style 'options', use explicit 'retry' and 'timeout'.

Closes #5560.  (Other elements of that bug will be fixed in 'gapic-generator'
(see: googleapis/gapic-generator#2388) and
propagated via autosynth.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: bigquerydatatransfer Issues related to the BigQuery Data Transfer Service API. api: cloudiot Issues related to the IoT Core API. api: dataproc Issues related to the Dataproc API. api: monitoring Issues related to the Cloud Monitoring API. api: vision Issues related to the Cloud Vision API. cla: yes This human has signed the Contributor License Agreement. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Monitoring: where is CallOptions on monitoring API example?
3 participants