DOC : cleaned up/clarified docstring

tacaswell · tacaswell · commit 23b524046d0e · 2014-07-09T02:00:11.000-04:00
diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py
@@ -548,9 +548,11 @@ def add_label_clabeltext(self, x, y, rotation, lev, cvalue):
     def add_label_near(self, x, y, inline=True, inline_spacing=5,
                        transform=None):
         """
-        Add a label near the point (x, y) of the given transform.
-        If transform is None, data transform is used. If transform is
-        False, IdentityTransform is used.
+        Add a label near the point (x, y). If transform is None
+        (default), (x, y) is in data coordinates; if transform is
+        False, (x, y) is in display coordinates; otherwise, the
+        specified transform will be used to translate (x, y) into
+        display coordinates.
 
         *inline*:
           controls whether the underlying contour is removed or
@@ -562,15 +564,11 @@ def add_label_near(self, x, y, inline=True, inline_spacing=5,
           exact for labels at locations where the contour is
           straight, less so for labels on curved contours.
         """
-        # if 'do the default thing' use the axes data transform
+
         if transform is None:
             transform = self.ax.transData
 
-        # if transform is 'falsey' don't do any transform (this is a
-        # really awful API but is what we have)
         if transform:
-            # The point of this transform is to get the location
-            # of label position into screen units
             x, y = transform.transform_point((x, y))
 
         # find the nearest contour _in screen units_
@@ -586,8 +584,7 @@ def add_label_near(self, x, y, inline=True, inline_spacing=5,
         active_path = paths[segmin]
         # grab it's verticies
         lc = active_path.vertices
-        # sort out where the new vertex should be added in the path's data
-        # units
+        # sort out where the new vertex should be added data-units
         xcmin = self.ax.transData.inverted().transform_point([xmin, ymin])
         # if there isn't a vertex close enough
         if not np.allclose(xcmin, lc[imin]):
