Backport PR #9478: Added description to widget example programs except Cursor and Menu

NelleV · MeeseeksDev[bot] · commit 16195781b840 · 2017-10-21T18:23:59.000Z
diff --git a/examples/widgets/buttons.py b/examples/widgets/buttons.py
@@ -3,6 +3,10 @@
 Buttons
 =======
 
+Constructing a simple button GUI to modify a sine wave.
+
+The ``next`` and ``previous`` button widget helps visualize the wave with
+new frequencies.
 """
 
 import numpy as np
diff --git a/examples/widgets/check_buttons.py b/examples/widgets/check_buttons.py
@@ -3,6 +3,11 @@
 Check Buttons
 =============
 
+Turning visual elements on and off with check buttons.
+
+This program shows the use of 'Check Buttons' which is similar to
+check boxes. There are 3 different sine waves shown and we can choose which
+waves are displayed with the check buttons.
 """
 import numpy as np
 import matplotlib.pyplot as plt
diff --git a/examples/widgets/lasso_selector_demo_sgskip.py b/examples/widgets/lasso_selector_demo_sgskip.py
@@ -3,6 +3,11 @@
 Lasso Selector Demo
 ===================
 
+Interactively selecting data points with the lasso tool.
+
+This examples plots a scatter plot. You can then select a few points by drawing
+a lasso loop around the points on the graph. To draw, just click
+on the graph, hold, and drag it around the points you need to select.
 """
 from __future__ import print_function
 
diff --git a/examples/widgets/multicursor.py b/examples/widgets/multicursor.py
@@ -3,6 +3,11 @@
 Multicursor
 ===========
 
+Showing a cursor on multiple plots simultaneously.
+
+This example generates two subplots and on hovering
+the cursor over data in one subplot, the values of that datapoint
+are shown in both respectively.
 """
 import numpy as np
 import matplotlib.pyplot as plt
diff --git a/examples/widgets/radio_buttons.py b/examples/widgets/radio_buttons.py
@@ -3,6 +3,11 @@
 Radio Buttons
 =============
 
+Using radio buttons to choose properties of your plot.
+
+Radio buttons let you choose between multiple options in a visualization.
+In this case, the buttons let the user choose one of the three different sine
+waves to be shown in the plot.
 """
 import numpy as np
 import matplotlib.pyplot as plt
diff --git a/examples/widgets/slider_demo.py b/examples/widgets/slider_demo.py
@@ -3,6 +3,11 @@
 Slider Demo
 ===========
 
+Using the slider widget to control visual properties of your plot.
+
+In this example, a slider is used to choose the frequency of a sine
+wave. You can control many continuously-varying properties of your plot in
+this way.
 """
 import numpy as np
 import matplotlib.pyplot as plt
diff --git a/examples/widgets/textbox.py b/examples/widgets/textbox.py
@@ -3,6 +3,11 @@
 Textbox
 =======
 
+Allowing text input with the Textbox widget.
+
+You can use the Textbox widget to let users provide any text that needs to be
+displayed, including formulas. You can use a submit button to create plots
+with the given input.
 """
 
 import numpy as np
