Added an example to the docstring of the on_selection function

jonmmease · jonmmease · commit 3fa38e552a94 · 2018-07-05T08:11:02.000-04:00
diff --git a/plotly/basedatatypes.py b/plotly/basedatatypes.py
@@ -3857,6 +3857,21 @@ def on_selection(
         Returns
         -------
         None
+
+        Examples
+        --------
+        >>> from plotly.callbacks import Points
+        >>> points = Points()
+
+        >>> def selection_fn(trace, points, selector):
+        ...     inds = points.point_inds
+        ...     # Do something
+
+        >>> trace.on_selection(selection_fn)
+
+        Note: The creation of the `points` object is optional,
+        it's simply a convenience to help the text editor perform completion
+        on the `points` arguments inside `selection_fn`
         """
         if not append:
             del self._select_callbacks[:]
