From 761dfe75d0b89e56137961a9fa28e12c63e05c28 Mon Sep 17 00:00:00 2001 From: HemangChothani Date: Thu, 7 May 2020 15:58:25 +0530 Subject: [PATCH] docs(bigtable): add doc file of row_set class and related changes --- docs/row-set.rst | 6 ++++++ docs/usage.rst | 1 + google/cloud/bigtable/table.py | 6 +++--- 3 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 docs/row-set.rst diff --git a/docs/row-set.rst b/docs/row-set.rst new file mode 100644 index 000000000..5f7a16a02 --- /dev/null +++ b/docs/row-set.rst @@ -0,0 +1,6 @@ +Row Set +~~~~~~~~ + +.. automodule:: google.cloud.bigtable.row_set + :members: + :show-inheritance: diff --git a/docs/usage.rst b/docs/usage.rst index aa8d899d5..4e2776805 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -13,6 +13,7 @@ Using the API row row-data row-filters + row-set In the hierarchy of API concepts diff --git a/google/cloud/bigtable/table.py b/google/cloud/bigtable/table.py index 69379b21d..dd3ba9b1f 100644 --- a/google/cloud/bigtable/table.py +++ b/google/cloud/bigtable/table.py @@ -537,7 +537,7 @@ def read_rows( :param end_inclusive: (Optional) Whether the ``end_key`` should be considered inclusive. The default is False (exclusive). - :type row_set: :class:`row_set.RowSet` + :type row_set: :class:`.RowSet` :param row_set: (Optional) The row set containing multiple row keys and row_ranges. @@ -593,7 +593,7 @@ def yield_rows(self, **kwargs): specified row(s). If unset, reads every column in each row. - :type row_set: :class:`row_set.RowSet` + :type row_set: :class:`.RowSet` :param row_set: (Optional) The row set containing multiple row keys and row_ranges. @@ -1031,7 +1031,7 @@ def _create_row_request( :type: app_profile_id: str :param app_profile_id: (Optional) The unique name of the AppProfile. - :type row_set: :class:`row_set.RowSet` + :type row_set: :class:`.RowSet` :param row_set: (Optional) The row set containing multiple row keys and row_ranges.