Docs: fix GAX fossils (#6264)

* 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.
googleapis · Oct 24, 2018 · d144a00 · d144a00
1 parent 53d8146
commit d144a00
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 6 deletions.
diff --git a/bigquery_datatransfer/README.rst b/bigquery_datatransfer/README.rst
@@ -88,7 +88,7 @@ DataTransferServiceClient
         pass
 
     # Or iterate over results one page at a time
-    for page in client.list_data_sources(parent, options=CallOptions(page_token=INITIAL_PAGE)):
+    for page in client.list_data_sources(parent).pages:
         for element in page:
             # process element
             pass

diff --git a/dataproc/README.rst b/dataproc/README.rst
@@ -87,7 +87,7 @@ Example Usage
         pass
 
     # Or iterate over results one page at a time
-    for page in client.list_clusters(project_id, region, options=CallOptions(page_token=INITIAL_PAGE)):
+    for page in client.list_clusters(project_id, region).pages:
         for element in page:
             # process element
             pass

diff --git a/iot/README.rst b/iot/README.rst
@@ -90,7 +90,7 @@ DeviceManagerClient
         pass
 
     # Or iterate over results one page at a time
-    for page in client.list_device_registries(parent, options=CallOptions(page_token=INITIAL_PAGE)):
+    for page in client.list_device_registries(parent).pages:
         for element in page:
             # process element
             pass

diff --git a/monitoring/README.rst b/monitoring/README.rst
@@ -90,7 +90,7 @@ MetricServiceClient
         pass
 
     # Or iterate over results one page at a time
-    for page in client.list_monitored_resource_descriptors(name, options=CallOptions(page_token=INITIAL_PAGE)):
+    for page in client.list_monitored_resource_descriptors(name).pages:
         for element in page:
             # process element
             pass

diff --git a/vision/google/cloud/vision_helpers/__init__.py b/vision/google/cloud/vision_helpers/__init__.py
@@ -40,8 +40,12 @@ def annotate_image(self, request, retry=None, timeout=None):
 
         Args:
             request (:class:`~.vision_v1.types.AnnotateImageRequest`)
-            options (:class:`google.gax.CallOptions`): Overrides the default
-                settings for this call, e.g, timeout, retries, etc.
+            retry (Optional[google.api_core.retry.Retry]):  A retry object used
+                to retry requests. If ``None`` is specified, requests will not
+                be retried.
+            timeout (Optional[float]): The amount of time, in seconds, to wait
+                for the request to complete. Note that if ``retry`` is
+                specified, the timeout applies to each individual attempt.
 
         Returns:
             :class:`~.vision_v1.types.AnnotateImageResponse` The API response.