Merge pull request #23746 from tacaswell/doc_ticlocs

timhoffm · web-flow · commit 54b2a638d575 · 2022-08-26T18:09:20.000+02:00
DOC: add numpydoc docstring + commentary to Axis.get_ticklocs
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -1457,7 +1457,22 @@ def get_minorticklocs(self):
         return minor_locs
 
     def get_ticklocs(self, *, minor=False):
-        """Return this Axis' tick locations in data coordinates."""
+        """
+        Return this Axis' tick locations in data coordinates.
+
+        The locations are not clipped to the current axis limits and hence
+        may contain locations that are not visible in the output.
+
+        Parameters
+        ----------
+        minor : bool, default: False
+            True to return the minor tick directions,
+            False to return the major tick directions.
+
+        Returns
+        -------
+        numpy array of tick locations
+        """
         return self.get_minorticklocs() if minor else self.get_majorticklocs()
 
     def get_ticks_direction(self, minor=False):
