Merge pull request #13829 from dstansby/indexformatter-doc

anntzer · web-flow · commit 9144412c9c9d · 2019-04-01T16:28:57.000+02:00
numpydoc IndexFormatter
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -302,7 +302,13 @@ def _set_locator(self, locator):
 
 class IndexFormatter(Formatter):
     """
-    Format the position x to the nearest i-th label where i=int(x+0.5)
+    Format the position x to the nearest i-th label where ``i = int(x + 0.5)``.
+    Positions where ``i < 0`` or ``i > len(list)`` have no tick labels.
+
+    Parameters
+    ----------
+    labels : list
+        List of labels.
     """
     def __init__(self, labels):
         self.labels = labels
