Backport PR #30029: Update diagram in subplots_adjust documentation to clarify parameters

timhoffm · meeseeksmachine · commit d3c77afde1e3 · 2025-05-09T20:46:53.000Z
diff --git a/doc/_embedded_plots/figure_subplots_adjust.py b/doc/_embedded_plots/figure_subplots_adjust.py
@@ -1,28 +1,34 @@
 import matplotlib.pyplot as plt
 
 
-def arrow(p1, p2, **props):
-    axs[0, 0].annotate(
-        "", p1, p2,  xycoords='figure fraction',
-        arrowprops=dict(arrowstyle="<->", shrinkA=0, shrinkB=0, **props))
-
-
 fig, axs = plt.subplots(2, 2, figsize=(6.5, 4))
 fig.set_facecolor('lightblue')
 fig.subplots_adjust(0.1, 0.1, 0.9, 0.9, 0.4, 0.4)
+
+overlay = fig.add_axes([0, 0, 1, 1], zorder=100)
+overlay.axis("off")
+xycoords='figure fraction'
+arrowprops=dict(arrowstyle="<->", shrinkA=0, shrinkB=0)
+
 for ax in axs.flat:
     ax.set(xticks=[], yticks=[])
 
-arrow((0, 0.75), (0.1, 0.75))  # left
-arrow((0.435, 0.75), (0.565, 0.75))  # wspace
-arrow((0.9, 0.75), (1, 0.75))  # right
+overlay.annotate("", (0, 0.75), (0.1, 0.75),
+                 xycoords=xycoords, arrowprops=arrowprops)  # left
+overlay.annotate("", (0.435, 0.25), (0.565, 0.25),
+                 xycoords=xycoords, arrowprops=arrowprops)  # wspace
+overlay.annotate("", (0, 0.8), (0.9, 0.8),
+                 xycoords=xycoords, arrowprops=arrowprops)  # right
 fig.text(0.05, 0.7, "left", ha="center")
-fig.text(0.5, 0.7, "wspace", ha="center")
-fig.text(0.95, 0.7, "right", ha="center")
+fig.text(0.5, 0.3, "wspace", ha="center")
+fig.text(0.05, 0.83, "right", ha="center")
 
-arrow((0.25, 0), (0.25, 0.1))  # bottom
-arrow((0.25, 0.435), (0.25, 0.565))  # hspace
-arrow((0.25, 0.9), (0.25, 1))  # top
-fig.text(0.28, 0.05, "bottom", va="center")
+overlay.annotate("", (0.75, 0), (0.75, 0.1),
+                 xycoords=xycoords, arrowprops=arrowprops)  # bottom
+overlay.annotate("", (0.25, 0.435), (0.25, 0.565),
+                 xycoords=xycoords, arrowprops=arrowprops)  # hspace
+overlay.annotate("", (0.8, 0), (0.8, 0.9),
+                 xycoords=xycoords, arrowprops=arrowprops)  # top
+fig.text(0.65, 0.05, "bottom", va="center")
 fig.text(0.28, 0.5, "hspace", va="center")
-fig.text(0.28, 0.95, "top", va="center")
+fig.text(0.82, 0.05, "top", va="center")
