Skip to content

Commit

Permalink
docs(python): mark .plot property as unstable (#17205)
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcoGorelli authored Jun 26, 2024
1 parent 048c784 commit 30e4d63
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
5 changes: 5 additions & 0 deletions py-polars/polars/dataframe/frame.py
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
Original file line number Diff line number Diff line change
Expand Up @@ -7305,10 +7305,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

0 comments on commit 30e4d63

Please sign in to comment.