Merge pull request #5688 from cimarronm/FuncFormatterDoc

tacaswell · tacaswell · commit 6b30aaab0f85 · 2015-12-17T00:04:20.000-05:00
DOC: Improved documentation for FuncFormatter formatter class
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -309,6 +309,9 @@ def set_offset_string(self, ofs):
 class FuncFormatter(Formatter):
     """
     User defined function for formatting
+
+    The function should take in two inputs (tick value *x* and position *pos*)
+    and return a string
     """
     def __init__(self, func):
         self.func = func
