Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add the docs for loc and iloc indexers #446

Merged
merged 6 commits into from
Mar 18, 2024
Merged

docs: add the docs for loc and iloc indexers #446

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3d8270a
docs:add the docs for loc and iloc indexers
ashleyxuu Mar 15, 2024
a83841f
Merge branch 'main' into ashleyxu-add-indexers-docs
tswast Mar 15, 2024
af39c20
Add docstrings
ashleyxuu Mar 15, 2024
7c1da10
Merge branch 'main' into ashleyxu-add-indexers-docs
ashleyxuu Mar 15, 2024
eb58864
address comments
ashleyxuu Mar 18, 2024
5458286
Merge branch 'main' into ashleyxu-add-indexers-docs
ashleyxuu Mar 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/reference/bigframes.pandas/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ BigQuery DataFrames (pandas)
general_functions
series
frame
indexers
indexing
window
groupby
Expand Down
32 changes: 32 additions & 0 deletions docs/reference/bigframes.pandas/indexers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@

=========
Indexers
=========

ILocDataFrameIndexer
--------------------
.. autoclass:: bigframes.core.indexers.ILocDataFrameIndexer
:members:
:inherited-members:
:undoc-members:

IlocSeriesIndexer
-----------------
.. autoclass:: bigframes.core.indexers.IlocSeriesIndexer
:members:
:inherited-members:
:undoc-members:

LocDataFrameIndexer
-------------------
.. autoclass:: bigframes.core.indexers.LocDataFrameIndexer
:members:
:inherited-members:
:undoc-members:

LocSeriesIndexer
----------------
.. autoclass:: bigframes.core.indexers.LocSeriesIndexer
:members:
:inherited-members:
:undoc-members:
12 changes: 10 additions & 2 deletions docs/templates/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,16 @@
- name: SeriesGroupBy
uid: bigframes.core.groupby.SeriesGroupBy
name: Groupby
- name: Indexes
uid: bigframes.core.indexes.index.Index
- items:
- name: ILocDataFrameIndexer
uid: bigframes.core.indexers.ILocDataFrameIndexer
- name: IlocSeriesIndexer
uid: bigframes.core.indexers.IlocSeriesIndexer
- name: LocDataFrameIndexer
uid: bigframes.core.indexers.LocDataFrameIndexer
- name: LocSeriesIndexer
uid: bigframes.core.indexers.LocSeriesIndexer
name: Indexers
- name: pandas
uid: bigframes.pandas
- items:
Expand Down