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

Commit 65de1a5

Browse files
committed
Updated docstrings
1 parent 119ea87 commit 65de1a5

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

google/cloud/bigtable/row_data.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,14 @@ class InvalidRetryRequest(RuntimeError):
6868
class PartialRowsData(object):
6969
"""Convenience wrapper for consuming a ``ReadRows`` streaming response.
7070
71+
This class will be returned by the ``read_rows`` method, and should not
72+
be constructed manually.
73+
7174
:type read_method: :class:`client._table_data_client.read_rows`
7275
:param read_method: ``ReadRows`` method.
7376
7477
:type generator: :class:`Iterable[Row]`
75-
:param generator: The `Row` iterator from :meth:`Table.read_rows`. This is not intended
76-
to be created directly.
78+
:param generator: The `Row` iterator from :meth:`Table.read_rows`.
7779
"""
7880

7981
def __init__(self, generator):
@@ -92,7 +94,9 @@ def consume_all(self, max_loops=None):
9294
class as a generator instead.
9395
9496
:type max_loops: int
95-
:param max_loops: (Deprecated). This parameter does nothing.
97+
:param max_loops: (Deprecated). Maximum number of times to try to consume
98+
an additional ``ReadRowsResponse``. This parameter is
99+
deprecated and is only kept for backwards compatibility.
96100
"""
97101
for row in self:
98102
self.rows[row.row_key] = row

0 commit comments

Comments
 (0)