Merge pull request #18123 from timhoffm/doc-figure-title

QuLogic · web-flow · commit 29ba9a9a22ee · 2020-07-30T00:44:04.000-04:00
Cleanup figure title example
diff --git a/examples/subplots_axes_and_figures/figure_title.py b/examples/subplots_axes_and_figures/figure_title.py
@@ -1,34 +1,27 @@
 """
 ============
-Figure Title
+Figure title
 ============
 
-Create a figure with separate subplot titles and a centered figure title.
+Each subplot can have its own title (`.Axes.set_title`). Additionally,
+`.Figure.suptitle` adds a centered title at the top of the figure.
 """
 import matplotlib.pyplot as plt
 import numpy as np
 
 
-def f(t):
-    s1 = np.cos(2*np.pi*t)
-    e1 = np.exp(-t)
-    return s1 * e1
+x = np.linspace(0.0, 5.0, 501)
 
-t1 = np.arange(0.0, 5.0, 0.1)
-t2 = np.arange(0.0, 5.0, 0.02)
-t3 = np.arange(0.0, 2.0, 0.01)
+fig, (ax1, ax2) = plt.subplots(1, 2, constrained_layout=True, sharey=True)
+ax1.plot(x, np.cos(6*x) * np.exp(-x))
+ax1.set_title('damped')
+ax1.set_xlabel('time (s)')
+ax1.set_ylabel('amplitude')
 
+ax2.plot(x, np.cos(6*x))
+ax2.set_xlabel('time (s)')
+ax2.set_title('undamped')
 
-fig, axs = plt.subplots(2, 1, constrained_layout=True)
-axs[0].plot(t1, f(t1), 'o', t2, f(t2), '-')
-axs[0].set_title('subplot 1')
-axs[0].set_xlabel('distance (m)')
-axs[0].set_ylabel('Damped oscillation')
-fig.suptitle('This is a somewhat long figure title', fontsize=16)
-
-axs[1].plot(t3, np.cos(2*np.pi*t3), '--')
-axs[1].set_xlabel('time (s)')
-axs[1].set_title('subplot 2')
-axs[1].set_ylabel('Undamped')
+fig.suptitle('Different types of oscillations', fontsize=16)
 
 plt.show()
