ENH: Added support for both x and pos to StrMethodFormatter

madphysicist · madphysicist · commit f51d58cd7ad3 · 2016-03-30T11:13:37.000-04:00
This should not break backwards compatibility since extra keywords are allowed
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -363,14 +363,22 @@ def __call__(self, x, pos=None):
 class StrMethodFormatter(Formatter):
     """
     Use a new-style format string (as used by `str.format()`)
-    to format the tick.  The field formatting must be labeled `x`.
+    to format the tick.
+
+    The field used for the value must be labeled `x` and the field used
+    for the position must be labeled `pos`.
     """
     def __init__(self, fmt):
         self.fmt = fmt
 
     def __call__(self, x, pos=None):
-        'Return the format for tick val *x* at position *pos*'
-        return self.fmt.format(x=x)
+        """
+        Return the formatted label string.
+
+        `x` and `pos` are passed to `str.format` as keyword arguments
+        with those exact names.
+        """
+        return self.fmt.format(x=x, pos=pos)
 
 
 class OldScalarFormatter(Formatter):
