Skip to content

DOC: remove Panel4D from the API docs #15579 #15598

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
merged 1 commit into from
Mar 7, 2017
Merged

DOC: remove Panel4D from the API docs #15579 #15598

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
53 changes: 1 addition & 52 deletions doc/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1237,58 +1237,7 @@ Serialization / IO / Conversion
Panel.to_frame
Panel.to_xarray
Panel.to_clipboard

.. _api.panel4d:

Panel4D
-------

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: generated/

Panel4D

Serialization / IO / Conversion
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/

Panel4D.to_xarray

Attributes and underlying data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Axes**

* **labels**: axis 1; each label corresponds to a Panel contained inside
* **items**: axis 2; each item corresponds to a DataFrame contained inside
* **major_axis**: axis 3; the index (rows) of each of the DataFrames
* **minor_axis**: axis 4; the columns of each of the DataFrames

.. autosummary::
:toctree: generated/

Panel4D.values
Panel4D.axes
Panel4D.ndim
Panel4D.size
Panel4D.shape
Panel4D.dtypes
Panel4D.ftypes
Panel4D.get_dtype_counts
Panel4D.get_ftype_counts

Conversion
~~~~~~~~~~
.. autosummary::
:toctree: generated/

Panel4D.astype
Panel4D.copy
Panel4D.isnull
Panel4D.notnull


.. _api.index:

Index
Expand Down
4 changes: 2 additions & 2 deletions scripts/api_rst_coverage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

def main():
# classes whose members to check
classes = [pd.Series, pd.DataFrame, pd.Panel, pd.Panel4D]
classes = [pd.Series, pd.DataFrame, pd.Panel]

def class_name_sort_key(x):
if x.startswith('Series'):
# make sure Series precedes DataFrame, Panel, and Panel4D
# make sure Series precedes DataFrame, and Panel.
return ' ' + x
else:
return x
Expand Down