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 pages for at and iat indexers #456

Merged
merged 1 commit into from
Mar 19, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 28 additions & 0 deletions docs/reference/bigframes.pandas/indexers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions docs/templates/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 10 additions & 2 deletions third_party/bigframes_vendored/pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
12 changes: 10 additions & 2 deletions third_party/bigframes_vendored/pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3331,12 +3331,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
Expand Down