From 0dc3fd86d13883bc1c50fd5346ae4b25c8436a44 Mon Sep 17 00:00:00 2001
From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
Date: Tue, 23 Apr 2019 14:59:25 +0200
Subject: [PATCH] Update docstring of locator_params()

---
 lib/matplotlib/axes/_base.py | 25 ++++++++++++++-----------
 1 file changed, 14 insertions(+), 11 deletions(-)

diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
index 4a5d0797e724..42a95d735abf 100644
--- a/lib/matplotlib/axes/_base.py
+++ b/lib/matplotlib/axes/_base.py
@@ -2859,7 +2859,10 @@ def ticklabel_format(self, *, axis='both', style='', scilimits=None,
 
     def locator_params(self, axis='both', tight=None, **kwargs):
         """
-        Control behavior of tick locators.
+        Control behavior of major tick locators.
+
+        Because the locator is involved in autoscaling, `~.Axes.autoscale_view`
+        is called automatically after the parameters are changed.
 
         Parameters
         ----------
@@ -2867,25 +2870,25 @@ def locator_params(self, axis='both', tight=None, **kwargs):
             The axis on which to operate.
 
         tight : bool or None, optional
-            Parameter passed to :meth:`autoscale_view`.
+            Parameter passed to `~.Axes.autoscale_view`.
             Default is None, for no change.
 
         Other Parameters
         ----------------
-        **kw
+        **kwargs
             Remaining keyword arguments are passed to directly to the
-            :meth:`~matplotlib.ticker.MaxNLocator.set_params` method.
+            ``set_params()`` method of the locator. Supported keywords depend
+            on the type of the locator. See for example
+            `~.ticker.MaxNLocator.set_params` for the `.ticker.MaxNLocator`
+            used by default for linear axes.
 
-        Typically one might want to reduce the maximum number of ticks and use
-        tight bounds when plotting small subplots, for example::
+        Examples
+        --------
+        When plotting small subplots, one might want to reduce the maximum
+        number of ticks and use tight bounds, for example::
 
             ax.locator_params(tight=True, nbins=4)
 
-        Because the locator is involved in autoscaling, :meth:`autoscale_view`
-        is called automatically after the parameters are changed.
-
-        This presently works only for the `~matplotlib.ticker.MaxNLocator` used
-        by default on linear axes, but it may be generalized.
         """
         _x = axis in ['x', 'both']
         _y = axis in ['y', 'both']