Merge pull request #28459 from timhoffm/doc-tick-kwargs

QuLogic · web-flow · commit f54dd516cf5a · 2024-06-25T17:41:27.000-04:00
DOC: Document kwargs scope for tick setter functions
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -2028,7 +2028,9 @@ def set_ticklabels(self, labels, *, minor=False, fontdict=None, **kwargs):
 
             .. warning::
 
-                This only sets the properties of the current ticks.
+                This only sets the properties of the current ticks, which is
+                only sufficient for static plots.
+
                 Ticks are not guaranteed to be persistent. Various operations
                 can create, delete and modify the Tick instances. There is an
                 imminent risk that these settings can get lost if you work on
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -2182,6 +2182,21 @@ def xticks(
     **kwargs
         `.Text` properties can be used to control the appearance of the labels.
 
+        .. warning::
+
+            This only sets the properties of the current ticks, which is
+            only sufficient if you either pass *ticks*, resulting in a
+            fixed list of ticks, or if the plot is static.
+
+            Ticks are not guaranteed to be persistent. Various operations
+            can create, delete and modify the Tick instances. There is an
+            imminent risk that these settings can get lost if you work on
+            the figure further (including also panning/zooming on a
+            displayed figure).
+
+            Use `~.pyplot.tick_params` instead if possible.
+
+
     Returns
     -------
     locs
@@ -2253,6 +2268,20 @@ def yticks(
     **kwargs
         `.Text` properties can be used to control the appearance of the labels.
 
+        .. warning::
+
+            This only sets the properties of the current ticks, which is
+            only sufficient if you either pass *ticks*, resulting in a
+            fixed list of ticks, or if the plot is static.
+
+            Ticks are not guaranteed to be persistent. Various operations
+            can create, delete and modify the Tick instances. There is an
+            imminent risk that these settings can get lost if you work on
+            the figure further (including also panning/zooming on a
+            displayed figure).
+
+            Use `~.pyplot.tick_params` instead if possible.
+
     Returns
     -------
     locs
