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.

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

DOC: Update doc strings to show pd.Panel has been deprecated #18956

Merged
merged 1 commit into from
Dec 27, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions pandas/core/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -1403,6 +1403,8 @@ def to_panel(self):
Transform long (stacked) format (DataFrame) into wide (3D, Panel)
format.

.. deprecated:: 0.20.0

Currently the index of the DataFrame must be a 2-level MultiIndex. This
may be generalized later

Expand Down
7 changes: 7 additions & 0 deletions pandas/core/panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,13 @@ class Panel(NDFrame):
"""
Represents wide format panel data, stored as 3-dimensional array

.. deprecated:: 0.20.0
The recommended way to represent 3-D data are with a MultiIndex on a
DataFrame via the :attr:`~Panel.to_frame()` method or with the
`xarray package <http://xarray.pydata.org/en/stable/>`__.
Pandas provides a :attr:`~Panel.to_xarray()` method to automate this
conversion.

Parameters
----------
data : ndarray (items x major x minor), or dict of DataFrames
Expand Down