Skip to content

Commit 340f0b5

Browse files
authored
docs: add the pages for at and iat indexers (#456)
1 parent 5dd9e6e commit 340f0b5

File tree

4 files changed

+56
-4
lines changed

4 files changed

+56
-4
lines changed

docs/reference/bigframes.pandas/indexers.rst

+28
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,34 @@
33
Indexers
44
=========
55

6+
AtDataFrameIndexer
7+
--------------------
8+
.. autoclass:: bigframes.core.indexers.AtDataFrameIndexer
9+
:members:
10+
:inherited-members:
11+
:undoc-members:
12+
13+
AtSeriesIndexer
14+
--------------------
15+
.. autoclass:: bigframes.core.indexers.AtSeriesIndexer
16+
:members:
17+
:inherited-members:
18+
:undoc-members:
19+
20+
IatDataFrameIndexer
21+
--------------------
22+
.. autoclass:: bigframes.core.indexers.IatDataFrameIndexer
23+
:members:
24+
:inherited-members:
25+
:undoc-members:
26+
27+
IatSeriesIndexer
28+
--------------------
29+
.. autoclass:: bigframes.core.indexers.IatSeriesIndexer
30+
:members:
31+
:inherited-members:
32+
:undoc-members:
33+
634
ILocDataFrameIndexer
735
--------------------
836
.. autoclass:: bigframes.core.indexers.ILocDataFrameIndexer

docs/templates/toc.yml

+8
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,14 @@
4141
uid: bigframes.core.groupby.SeriesGroupBy
4242
name: Groupby
4343
- items:
44+
- name: AtDataFrameIndexer
45+
uid: bigframes.core.indexers.AtDataFrameIndexer
46+
- name: AtSeriesIndexer
47+
uid: bigframes.core.indexers.AtSeriesIndexer
48+
- name: IatDataFrameIndexer
49+
uid: bigframes.core.indexers.IatDataFrameIndexer
50+
- name: IatSeriesIndexer
51+
uid: bigframes.core.indexers.IatSeriesIndexer
4452
- name: ILocDataFrameIndexer
4553
uid: bigframes.core.indexers.ILocDataFrameIndexer
4654
- name: IlocSeriesIndexer

third_party/bigframes_vendored/pandas/core/frame.py

+10-2
Original file line numberDiff line numberDiff line change
@@ -5129,12 +5129,20 @@ def loc(self):
51295129

51305130
@property
51315131
def iat(self):
5132-
"""Access a single value for a row/column pair by integer position."""
5132+
"""Access a single value for a row/column pair by integer position.
5133+
5134+
Returns:
5135+
bigframes.core.indexers.IatDataFrameIndexer: Indexers object.
5136+
"""
51335137
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
51345138

51355139
@property
51365140
def at(self):
5137-
"""Access a single value for a row/column label pair."""
5141+
"""Access a single value for a row/column label pair.
5142+
5143+
Returns:
5144+
bigframes.core.indexers.AtDataFrameIndexer: Indexers object.
5145+
"""
51385146
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
51395147

51405148
def dot(self, other):

third_party/bigframes_vendored/pandas/core/series.py

+10-2
Original file line numberDiff line numberDiff line change
@@ -3278,12 +3278,20 @@ def loc(self):
32783278

32793279
@property
32803280
def iat(self):
3281-
"""Access a single value for a row/column pair by integer position."""
3281+
"""Access a single value for a row/column pair by integer position.
3282+
3283+
Returns:
3284+
bigframes.core.indexers.IatSeriesIndexer: Indexers object.
3285+
"""
32823286
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
32833287

32843288
@property
32853289
def at(self):
3286-
"""Access a single value for a row/column label pair."""
3290+
"""Access a single value for a row/column label pair.
3291+
3292+
Returns:
3293+
bigframes.core.indexers.AtSeriesIndexer: Indexers object.
3294+
"""
32873295
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
32883296

32893297
@property

0 commit comments

Comments
 (0)