API example in docs

docs/plugins.rst

@@ -44,6 +44,27 @@ This plugin allows choosing which column in the underlying data should be used a
 throughout the app (when plotting and in any data analysis plugins).
 
 
+.. code-block:: python
+
+  from lcviz import LCviz
+  lc = search_lightcurve("HAT-P-11", mission="Kepler",
+                         cadence="long", quarter=10).download().flatten()
+  lcviz = LCviz()
+  lcviz.load_data(lc)
+  lcviz.show()
+
+  flux_origin = lcviz.plugins['Flux Origin']
+  print(flux_origin.flux_origin.choices)
+  flux_origin.flux_origin = 'sap_flux'
+
+
+.. seealso::
+
+    This plugin reproduces the behavior also available in ``lightkurve`` as:
+
+    * :meth:`lightkurve.LightCurve.select_flux`
+
+
 .. _plot-options:
 
 Plot Options

lcviz/tests/test_plugin_flux_origin.py

@@ -1,6 +1,18 @@
 from numpy.testing import assert_allclose
 
 
+def test_docs_snippets(helper, light_curve_like_kepler_quarter):
+    lcviz, lc = helper, light_curve_like_kepler_quarter
+
+    lcviz.load_data(lc)
+    # lcviz.show()
+
+    flux_origin = lcviz.plugins['Flux Origin']
+    print(flux_origin.flux_origin.choices)
+    # NOTE: choices for docs example are: ['sap_flux', 'sap_bkg', 'pdcsap_flux']
+    flux_origin.flux_origin = 'flux_alt'
+
+
 def test_plugin_flux_origin(helper, light_curve_like_kepler_quarter):
     helper.load_data(light_curve_like_kepler_quarter)