8000 docs: Add DataFrame.struct docs by chelsea-lin · Pull Request #1348 · googleapis/python-bigquery-dataframes · GitHub
[go: up one dir, main page]
Skip to content

docs: Add DataFrame.struct docs #1348

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

Merged
tswast merged 5 commits into from
Feb 12, 2025
Merged

docs: Add DataFrame.struct docs #1348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1e69d00
docs: Add DataFrame.struct docs
chelsea-lin Jan 30, 2025
40dffd9
add other
chelsea-lin Jan 31, 2025
ffa761e
autoclass for struct accessor
chelsea-lin Jan 31, 2025
88066bf
Merge branch 'main' into main_chelsealin_dfstructdoc
tswast Feb 6, 2025
6d6c828
Merge branch 'main' into main_chelsealin_dfstructdoc
chelsea-lin Feb 12, 2025
File filter

Filter by extension

8000
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/reference/bigframes.geopandas/geoseries.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ GeoSeries
:local:
:backlinks: none

Series
------
GeoSeries
---------

.. autoclass:: bigframes.geopandas.GeoSeries
:members:
Expand Down
16 changes: 16 additions & 0 deletions docs/reference/bigframes.pandas/frame.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
DataFrame
=========

.. contents:: Table of Contents
:depth: 2
:local:
:backlinks: none

DataFrame
---------

.. autoclass:: bigframes.dataframe.DataFrame
:members:
:inherited-members:
Expand All @@ -18,3 +26,11 @@ Plotting handling
:members:
:inherited-members:
:undoc-members:

Struct handling
^^^^^^^^^^^^^^^

.. autoclass:: bigframes.operations.structs.StructFrameAccessor
:members:
:inherited-members:
:undoc-members:
2 changes: 1 addition & 1 deletion docs/reference/bigframes.pandas/series.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ List handling
Struct handling
^^^^^^^^^^^^^^^

.. automodule:: bigframes.operations.structs
.. autoclass:: bigframes.operations.structs.StructAccessor
:members:
:inherited-members:
:undoc-members:
Expand Down
17 changes: 9 additions & 8 deletions docs/templates/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,13 @@
uid: bigframes.exceptions
name: Core Objects
- items:
- name: DataFrame
uid: bigframes.dataframe.DataFrame
- items:
- name: DataFrame
uid: bigframes.dataframe.DataFrame
- name: PlotAccessor
uid: bigframes.operations.plotting.PlotAccessor
- name: StructAccessor
uid: bigframes.operations.structs.StructFrameAccessor
- items:
- name: DataFrameGroupBy
uid: bigframes.core.groupby.DataFrameGroupBy
Expand Down Expand Up @@ -68,12 +73,6 @@
name: Indexers
- name: pandas
uid: bigframes.pandas
- items:
- name: Plotting
uid: bigframes.operations.plotting
- name: PlotAccessor
uid: bigframes.operations.plotting.PlotAccessor
name: Plotting
- items:
- name: Series
uid: bigframes.series.Series
Expand All @@ -83,6 +82,8 @@
uid: bigframes.operations.strings.StringMethods
- name: StructAccessor
uid: bigframes.operations.structs.StructAccessor
- name: PlotAccessor
uid: bigframes.operations.plotting.PlotAccessor
name: Series
- name: Window
uid: bigframes.core.window.Window
Expand Down
0