Merge pull request matplotlib#5688 from cimarronm/FuncFormatterDoc

DOC: Improved documentation for FuncFormatter formatter class
jayvdb · Dec 17, 2015 · 23bc09d · 23bc09d
2 parents 590f042 + a9f5070
commit 23bc09d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -326,6 +326,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