Merge pull request #13163 from mollyrossow/explain_annotation_example

jklymak · web-flow · commit 64eef6e6af93 · 2019-01-15T10:22:52.000-08:00
Add explanatory comment to annotation box example
diff --git a/examples/text_labels_and_annotations/demo_annotation_box.py b/examples/text_labels_and_annotations/demo_annotation_box.py
@@ -1,9 +1,14 @@
-"""
-===================
+"""===================
 Demo Annotation Box
 ===================
 
+The AnnotationBbox Artist creates an annotation using an OffsetBox. This
+example demonstrates three different OffsetBoxes: TextArea, DrawingArea and
+OffsetImage. AnnotationBbox gives more fine-grained control than using the axes
+method annotate.
+
 """
+
 import matplotlib.pyplot as plt
 import numpy as np
 
@@ -95,3 +100,23 @@
 ax.set_ylim(0, 1)
 
 plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions, methods and classes is shown in this
+# example:
+
+Circle
+TextArea
+DrawingArea
+OffsetImage
+AnnotationBbox
+get_sample_data
+plt.subplots
+plt.imread
+plt.show
