Skip to content

Commit 79bf611

Browse files
authored
Docs/fixit: normalize docs for 'page_size' / 'max_results' / 'page_token' (#6842)
1 parent b5b5406 commit 79bf611

2 files changed

Lines changed: 30 additions & 6 deletions

File tree

packages/google-cloud-spanner/google/cloud/spanner_v1/client.py

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -191,10 +191,18 @@ def list_instance_configs(self, page_size=None, page_token=None):
191191
See `RPC docs`_.
192192
193193
:type page_size: int
194-
:param page_size: (Optional) Maximum number of results to return.
194+
:param page_size:
195+
Optional. The maximum number of configs in each page of results
196+
from this request. Non-positive values are ignored. Defaults
197+
to a sensible value set by the API.
195198
196199
:type page_token: str
197-
:param page_token: (Optional) Token for fetching next page of results.
200+
:param page_token:
201+
Optional. If present, return the next batch of configs, using
202+
the value, which must correspond to the ``nextPageToken`` value
203+
returned in the previous response. Deprecated: use the ``pages``
204+
property of the returned iterator instead of manually passing
205+
the token.
198206
199207
:rtype: :class:`~google.api_core.page_iterator.Iterator`
200208
:returns:
@@ -256,10 +264,18 @@ def list_instances(self, filter_="", page_size=None, page_token=None):
256264
the ``ListInstancesRequest`` docs above for examples.
257265
258266
:type page_size: int
259-
:param page_size: (Optional) Maximum number of results to return.
267+
:param page_size:
268+
Optional. The maximum number of instances in each page of results
269+
from this request. Non-positive values are ignored. Defaults
270+
to a sensible value set by the API.
260271
261272
:type page_token: str
262-
:param page_token: (Optional) Token for fetching next page of results.
273+
:param page_token:
274+
Optional. If present, return the next batch of instances, using
275+
the value, which must correspond to the ``nextPageToken`` value
276+
returned in the previous response. Deprecated: use the ``pages``
277+
property of the returned iterator instead of manually passing
278+
the token.
263279
264280
:rtype: :class:`~google.api_core.page_iterator.Iterator`
265281
:returns:

packages/google-cloud-spanner/google/cloud/spanner_v1/instance.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -338,10 +338,18 @@ def list_databases(self, page_size=None, page_token=None):
338338
https://cloud.google.com/spanner/reference/rpc/google.spanner.admin.database.v1#google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases
339339
340340
:type page_size: int
341-
:param page_size: (Optional) Maximum number of results to return.
341+
:param page_size:
342+
Optional. The maximum number of databases in each page of results
343+
from this request. Non-positive values are ignored. Defaults
344+
to a sensible value set by the API.
342345
343346
:type page_token: str
344-
:param page_token: (Optional) Token for fetching next page of results.
347+
:param page_token:
348+
Optional. If present, return the next batch of databases, using
349+
the value, which must correspond to the ``nextPageToken`` value
350+
returned in the previous response. Deprecated: use the ``pages``
351+
property of the returned iterator instead of manually passing
352+
the token.
345353
346354
:rtype: :class:`~google.api._ore.page_iterator.Iterator`
347355
:returns:

0 commit comments

Comments
 (0)