Skip to content

Commit 66b247a

Browse files
committed
🖍️ docs-fix for #275
1 parent 4c12ab4 commit 66b247a

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

plotly_resampler/registering.py

+6-4
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,12 @@ def register_plotly_resampler(mode="auto", **aggregator_kwargs):
8888
We advise to use mode= ``widget`` when working in an IPython based environment
8989
as this will just behave as a ``go.FigureWidget``, but with dynamic aggregation.
9090
When using mode= ``auto`` or ``figure``; most figures will be wrapped as
91-
[`FigureResampler`][figure_resampler.FigureResampler],
92-
on which
93-
[`show_dash`][figure_resampler.FigureResampler.show_dash]
94-
needs to be called.
91+
[`FigureResampler`][figure_resampler.FigureResampler], on which
92+
[`show_dash`][figure_resampler.FigureResampler.show_dash] needs to be called.
93+
94+
!!! note
95+
This function is mostly useful for notebooks. For dash-apps, we advise to look
96+
at the dash app examples on [GitHub](https://github.com/predict-idlab/plotly-resampler/tree/main/examples#2-dash-apps)
9597
9698
Parameters
9799
----------

0 commit comments

Comments
 (0)