Modify example for x-axis tick labels at the top

timhoffm · timhoffm · commit 9e87dc82c628 · 2022-01-25T20:37:09.000+01:00
Primarily describe how to do this for a single Axes (using `tick_params`).
Only mention the `rcParams` in a note. Globally changing `rcParams` is
usually not a good idea and should not be demonstrated. The whole
topic of `rcParams` (global, context, matplotlibrc) is too long to
be discussed here and not the focus of the example.
diff --git a/examples/ticks/tick_xlabel_top.py b/examples/ticks/tick_xlabel_top.py
@@ -1,27 +1,32 @@
 """
-==========================================
-Set default x-axis tick labels on the top
-==========================================
+==================================
+Move x-axis tick labels to the top
+==================================
 
-We can use :rc:`xtick.labeltop` and :rc:`xtick.top` and :rc:`xtick.labelbottom`
-and :rc:`xtick.bottom` to control where on the axes ticks and their labels
-appear.
+`~.axes.Axes.tick_params` can be used to configure the ticks. *top* and
+*labeltop* control the visibility tick lines and labels at the top x-axis.
+To move x-axis ticks from bottom to top, we have to activate the top ticks
+and deactivate the bottom ticks::
 
-These properties can also be set in ``.matplotlib/matplotlibrc``.
-"""
+    ax.tick_params(top=True, labeltop=True, bottom=False, labelbottom=False)
 
-import matplotlib.pyplot as plt
-import numpy as np
+.. note::
+
+    If the change should be made for all future plots and not only the current
+    Axes, you can adapt the respective config parameters
 
+    - :rc:`xtick.top`
+    - :rc:`xtick.labeltop`
+    - :rc:`xtick.bottom`
+    - :rc:`xtick.labelbottom`
 
-plt.rcParams['xtick.bottom'] = plt.rcParams['xtick.labelbottom'] = False
-plt.rcParams['xtick.top'] = plt.rcParams['xtick.labeltop'] = True
+"""
 
-x = np.arange(10)
+import matplotlib.pyplot as plt
 
 fig, ax = plt.subplots()
-
-ax.plot(x)
-ax.set_title('xlabel top')  # Note title moves to make room for ticks
+ax.plot(range(10))
+ax.tick_params(top=True, labeltop=True, bottom=False, labelbottom=False)
+ax.set_title('x-ticks moved to the top')
 
 plt.show()
