Merge pull request #5709 from dsquareindia/param-fix

tacaswell · tacaswell · commit 82b29ae09fa6 · 2015-12-22T16:47:00.000-05:00
DOC: clarify annotation parameter usage #5704
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -633,21 +633,22 @@ def annotate(self, *args, **kwargs):
             label
 
         xy : (x, y)
-            position of element to annotate
+            position of element to annotate. See *xycoords* to control what
+            coordinate system this value is interpretated in.
 
         xytext : (x, y) , optional, default: None
-            position of the label `s`
+            position of the label `s`. See *textcoords* to control what
+            coordinate system this value is interpreted in.
 
         xycoords : string, optional, default: "data"
             string that indicates what type of coordinates `xy` is. Examples:
             "figure points", "figure pixels", "figure fraction", "axes
             points", .... See `matplotlib.text.Annotation` for more details.
 
-        textcoords : string, optional
+        textcoords : string, optional, default: None
             string that indicates what type of coordinates `text` is. Examples:
             "figure points", "figure pixels", "figure fraction", "axes
             points", .... See `matplotlib.text.Annotation` for more details.
-            Default is None.
 
         arrowprops : `matplotlib.lines.Line2D` properties, optional
             Dictionary of line properties for the arrow that connects
