Docs/fixit: normalize docs for 'page_size' / 'max_results' / 'page_token' (#6842)

Author: tseaver

google/cloud/logging/client.py

@@ -191,13 +191,18 @@ def list_entries(
                          or :data:`~google.cloud.logging.DESCENDING`.
 
         :type page_size: int
-        :param page_size: maximum number of entries to return, If not passed,
-                          defaults to a value set by the API.
+        :param page_size:
+            Optional. The maximum number of entries in each page of results
+            from this request. Non-positive values are ignored. Defaults
+            to a sensible value set by the API.
 
         :type page_token: str
-        :param page_token: opaque marker for the next "page" of entries. If not
-                           passed, the API will return the first page of
-                           entries.
+        :param page_token:
+            Optional. If present, return the next batch of entries, using
+            the value, which must correspond to the ``nextPageToken`` value
+            returned in the previous response.  Deprecated: use the ``pages``
+            property of the returned iterator instead of manually passing
+            the token.
 
         :rtype: :class:`~google.api_core.page_iterator.Iterator`
         :returns: Iterator of :class:`~google.cloud.logging.entries._BaseEntry`
@@ -244,13 +249,18 @@ def list_sinks(self, page_size=None, page_token=None):
         https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/list
 
         :type page_size: int
-        :param page_size: maximum number of sinks to return, If not passed,
-                          defaults to a value set by the API.
+        :param page_size:
+            Optional. The maximum number of sinks in each page of results from
+            this request. Non-positive values are ignored. Defaults to a
+            sensible value set by the API.
 
         :type page_token: str
-        :param page_token: opaque marker for the next "page" of sinks. If not
-                           passed, the API will return the first page of
-                           sinks.
+        :param page_token:
+            Optional. If present, return the next batch of sinks, using the
+            value, which must correspond to the ``nextPageToken`` value
+            returned in the previous response.  Deprecated: use the ``pages``
+            property of the returned iterator instead of manually passing the
+            token.
 
         :rtype: :class:`~google.api_core.page_iterator.Iterator`
         :returns: Iterator of
@@ -288,13 +298,18 @@ def list_metrics(self, page_size=None, page_token=None):
         https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.metrics/list
 
         :type page_size: int
-        :param page_size: maximum number of metrics to return, If not passed,
-                          defaults to a value set by the API.
+        :param page_size:
+            Optional. The maximum number of metrics in each page of results
+            from this request. Non-positive values are ignored. Defaults to a
+            sensible value set by the API.
 
         :type page_token: str
-        :param page_token: opaque marker for the next "page" of metrics. If not
-                           passed, the API will return the first page of
-                           metrics.
+        :param page_token:
+            Optional. If present, return the next batch of metrics, using the
+            value, which must correspond to the ``nextPageToken`` value
+            returned in the previous response.  Deprecated: use the ``pages``
+            property of the returned iterator instead of manually passing the
+            token.
 
         :rtype: :class:`~google.api_core.page_iterator.Iterator`
         :returns: Iterator of :class:`~google.cloud.logging.metric.Metric`

google/cloud/logging/logger.py

@@ -249,13 +249,18 @@ def list_entries(
                          or :data:`~google.cloud.logging.DESCENDING`.
 
         :type page_size: int
-        :param page_size: maximum number of entries to return, If not passed,
-                          defaults to a value set by the API.
+        :param page_size:
+            Optional. The maximum number of entries in each page of results
+            from this request. Non-positive values are ignored. Defaults
+            to a sensible value set by the API.
 
         :type page_token: str
-        :param page_token: opaque marker for the next "page" of entries. If not
-                           passed, the API will return the first page of
-                           entries.
+        :param page_token:
+            Optional. If present, return the next batch of entries, using
+            the value, which must correspond to the ``nextPageToken`` value
+            returned in the previous response.  Deprecated: use the ``pages``
+            property of the returned iterator instead of manually passing
+            the token.
 
         :rtype: :class:`~google.api_core.page_iterator.Iterator`
         :returns: Iterator of log entries accessible to the current logger.