docs: add the pages for at and iat indexers (#456)

googleapis · Mar 19, 2024 · 340f0b5 · 340f0b5
1 parent 5dd9e6e
commit 340f0b5
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 4 deletions.
diff --git a/docs/reference/bigframes.pandas/indexers.rst b/docs/reference/bigframes.pandas/indexers.rst
@@ -3,6 +3,34 @@
 Indexers
 =========
 
+AtDataFrameIndexer
+--------------------
+.. autoclass:: bigframes.core.indexers.AtDataFrameIndexer
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+AtSeriesIndexer
+--------------------
+.. autoclass:: bigframes.core.indexers.AtSeriesIndexer
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+IatDataFrameIndexer
+--------------------
+.. autoclass:: bigframes.core.indexers.IatDataFrameIndexer
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+IatSeriesIndexer
+--------------------
+.. autoclass:: bigframes.core.indexers.IatSeriesIndexer
+    :members:
+    :inherited-members:
+    :undoc-members:
+
 ILocDataFrameIndexer
 --------------------
 .. autoclass:: bigframes.core.indexers.ILocDataFrameIndexer

diff --git a/docs/templates/toc.yml b/docs/templates/toc.yml
@@ -41,6 +41,14 @@
         uid: bigframes.core.groupby.SeriesGroupBy
       name: Groupby
     - items:
+      - name: AtDataFrameIndexer
+        uid: bigframes.core.indexers.AtDataFrameIndexer
+      - name: AtSeriesIndexer
+        uid: bigframes.core.indexers.AtSeriesIndexer
+      - name: IatDataFrameIndexer
+        uid: bigframes.core.indexers.IatDataFrameIndexer
+      - name: IatSeriesIndexer
+        uid: bigframes.core.indexers.IatSeriesIndexer
       - name: ILocDataFrameIndexer
         uid: bigframes.core.indexers.ILocDataFrameIndexer
       - name: IlocSeriesIndexer

diff --git a/third_party/bigframes_vendored/pandas/core/frame.py b/third_party/bigframes_vendored/pandas/core/frame.py
@@ -5129,12 +5129,20 @@ def loc(self):
 
     @property
     def iat(self):
-        """Access a single value for a row/column pair by integer position."""
+        """Access a single value for a row/column pair by integer position.
+
+        Returns:
+            bigframes.core.indexers.IatDataFrameIndexer: Indexers object.
+        """
         raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
 
     @property
     def at(self):
-        """Access a single value for a row/column label pair."""
+        """Access a single value for a row/column label pair.
+
+        Returns:
+            bigframes.core.indexers.AtDataFrameIndexer: Indexers object.
+        """
         raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
 
     def dot(self, other):

diff --git a/third_party/bigframes_vendored/pandas/core/series.py b/third_party/bigframes_vendored/pandas/core/series.py
@@ -3278,12 +3278,20 @@ def loc(self):
 
     @property
     def iat(self):
-        """Access a single value for a row/column pair by integer position."""
+        """Access a single value for a row/column pair by integer position.
+
+        Returns:
+            bigframes.core.indexers.IatSeriesIndexer: Indexers object.
+        """
         raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
 
     @property
     def at(self):
-        """Access a single value for a row/column label pair."""
+        """Access a single value for a row/column label pair.
+
+        Returns:
+            bigframes.core.indexers.AtSeriesIndexer: Indexers object.
+        """
         raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
 
     @property