Skip to content

Commit 14ab8d8

Browse files
authored
docs: add the docs for loc and iloc indexers (#446)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [ ] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/python-bigquery-dataframes/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) Fixes #<issue_number_goes_here> 🦕
1 parent adadb06 commit 14ab8d8

File tree

5 files changed

+71
-4
lines changed

5 files changed

+71
-4
lines changed

docs/reference/bigframes.pandas/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ BigQuery DataFrames (pandas)
99
general_functions
1010
series
1111
frame
12+
indexers
1213
indexing
1314
window
1415
groupby
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
2+
=========
3+
Indexers
4+
=========
5+
6+
ILocDataFrameIndexer
7+
--------------------
8+
.. autoclass:: bigframes.core.indexers.ILocDataFrameIndexer
9+
:members:
10+
:inherited-members:
11+
:undoc-members:
12+
13+
IlocSeriesIndexer
14+
-----------------
15+
.. autoclass:: bigframes.core.indexers.IlocSeriesIndexer
16+
:members:
17+
:inherited-members:
18+
:undoc-members:
19+
20+
LocDataFrameIndexer
21+
-------------------
22+
.. autoclass:: bigframes.core.indexers.LocDataFrameIndexer
23+
:members:
24+
:inherited-members:
25+
:undoc-members:
26+
27+
LocSeriesIndexer
28+
----------------
29+
.. autoclass:: bigframes.core.indexers.LocSeriesIndexer
30+
:members:
31+
:inherited-members:
32+
:undoc-members:

docs/templates/toc.yml

+10-2
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,16 @@
4040
- name: SeriesGroupBy
4141
uid: bigframes.core.groupby.SeriesGroupBy
4242
name: Groupby
43-
- name: Indexes
44-
uid: bigframes.core.indexes.index.Index
43+
- items:
44+
- name: ILocDataFrameIndexer
45+
uid: bigframes.core.indexers.ILocDataFrameIndexer
46+
- name: IlocSeriesIndexer
47+
uid: bigframes.core.indexers.IlocSeriesIndexer
48+
- name: LocDataFrameIndexer
49+
uid: bigframes.core.indexers.LocDataFrameIndexer
50+
- name: LocSeriesIndexer
51+
uid: bigframes.core.indexers.LocSeriesIndexer
52+
name: Indexers
4553
- name: pandas
4654
uid: bigframes.pandas
4755
- items:

third_party/bigframes_vendored/pandas/core/frame.py

+14-1
Original file line numberDiff line numberDiff line change
@@ -5111,7 +5111,20 @@ def replace(
51115111

51125112
@property
51135113
def iloc(self):
5114-
"""Purely integer-location based indexing for selection by position."""
5114+
"""Purely integer-location based indexing for selection by position.
5115+
5116+
Returns:
5117+
bigframes.core.indexers.ILocDataFrameIndexer: Purely integer-location Indexers.
5118+
"""
5119+
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
5120+
5121+
@property
5122+
def loc(self):
5123+
"""Access a group of rows and columns by label(s) or a boolean array.
5124+
5125+
Returns:
5126+
bigframes.core.indexers.ILocDataFrameIndexer: Indexers object.
5127+
"""
51155128
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
51165129

51175130
@property

third_party/bigframes_vendored/pandas/core/series.py

+14-1
Original file line numberDiff line numberDiff line change
@@ -3313,7 +3313,20 @@ def map(
33133313

33143314
@property
33153315
def iloc(self):
3316-
"""Purely integer-location based indexing for selection by position."""
3316+
"""Purely integer-location based indexing for selection by position.
3317+
3318+
Returns:
3319+
bigframes.core.indexers.IlocSeriesIndexer: Purely integer-location Indexers.
3320+
"""
3321+
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
3322+
3323+
@property
3324+
def loc(self):
3325+
"""Access a group of rows and columns by label(s) or a boolean array.
3326+
3327+
Returns:
3328+
bigframes.core.indexers.LocSeriesIndexer: Indexers object.
3329+
"""
33173330
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
33183331

33193332
@property

0 commit comments

Comments
 (0)