Skip to content

Commit 875abab

Browse files
committed
📝 add .show documentation
1 parent 68ece6e commit 875abab

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

plotly_resampler/figure_resampler/figurewidget_resampler.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,13 @@ class FigureWidgetResampler(
2929
):
3030
"""Data aggregation functionality wrapper for ``go.FigureWidgets``.
3131
32-
.. attention:: This wrapper only works within ``jupyter``-based environments.
32+
.. attention::
33+
34+
* This wrapper only works within ``jupyter``-based environments.
35+
* The ``.show()`` method returns a **static figure** on which the
36+
**dynamic resampling cannot be performed**. To allow dynamic resampling,
37+
you should just output the ``FigureWidgetResampler`` object in a cell.
38+
3339
"""
3440

3541
def __init__(

0 commit comments

Comments
 (0)