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(python): Mark plot namespace as unstable #17205

Merged
merged 1 commit into from
Jun 26, 2024
Merged

docs(python): Mark plot namespace as unstable #17205

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
5 changes: 5 additions & 0 deletions py-polars/polars/dataframe/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,10 +563,15 @@ def _replace(self, column: str, new_column: Series) -> DataFrame:
return self

@property
@unstable()
def plot(self) -> hvPlotTabularPolars:
"""
Create a plot namespace.

.. warning::
This functionality is currently considered **unstable**. It may be
changed at any point without it being considered a breaking change.

Polars does not implement plotting logic itself, but instead defers to
hvplot. Please see the `hvplot reference gallery <https://hvplot.holoviz.org/reference/index.html>`_
for more information and documentation.
Expand Down
5 changes: 5 additions & 0 deletions py-polars/polars/series/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7312,10 +7312,15 @@ def struct(self) -> StructNameSpace:
return StructNameSpace(self)

@property
@unstable()
def plot(self) -> hvPlotTabularPolars:
"""
Create a plot namespace.

.. warning::
This functionality is currently considered **unstable**. It may be
changed at any point without it being considered a breaking change.

Polars does not implement plotting logic itself, but instead defers to
hvplot. Please see the `hvplot reference gallery <https://hvplot.holoviz.org/reference/index.html>`_
for more information and documentation.
Expand Down