Add a proper docstring to AutoLocator

afvincent · afvincent · commit 72bb777006a2 · 2017-10-24T16:14:54.000-07:00
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -2484,7 +2484,16 @@ def nonsingular(self, vmin, vmax):
 
 
 class AutoLocator(MaxNLocator):
+    """
+    Dynamically find major tick positions. This is actually a subclass
+    of `~matplotlib.ticker.MaxNLocator`, with parameters *nbins = 'auto'*
+    and *steps = [1, 2, 2.5, 5, 10]*.
+    """
     def __init__(self):
+        """
+        To know the values of the non-public parameters, please have a
+        look to the defaults of `~matplotlib.ticker.MaxNLocator`.
+        """
         if rcParams['_internal.classic_mode']:
             nbins = 9
             steps = [1, 2, 5, 10]
