8000 Update diagram in subplots_adjust documentation to clarify parameters by Bindi003 · Pull Request #30029 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Update diagram in subplots_adjust documentation to clarify parameters #30029

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 9, 2025
Merged

Update diagram in subplots_adjust documentation to clarify parameters #30029

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ac52254
Update diagram in subplots_adjust documentation to clarify parameter …
May 9, 2025
dd7f51b
Corrected subplots_adjust diagram
May 9, 2025
785140b
Addressed diagram feedback and simplified annotation calls
May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions doc/_embedded_plots/figure_subplots_adjust.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,30 @@
import matplotlib.pyplot as plt


def arrow(p1, p2, **props):

Check failure on line 3 in doc/_embedded_plots/figure_subplots_adjust.py

View workflow job for this annotation

GitHub Actions / ruff 

[rdjson] reported by reviewdog 🐶
Expected 2 blank lines, found 1

Raw Output:
message:"Expected 2 blank lines, found 1" location:{path:"/home/runner/work/matplotlib/matplotlib/doc/_embedded_plots/figure_subplots_adjust.py" range:{start:{line:3 column:1} end:{line:3 column:4}}} source:{name:"ruff" url:"https://docs.astral.sh/ruff"} code:{value:"E302" url:"https://docs.astral.sh/ruff/rules/blank-lines-top-level"} suggestions:{range:{start:{line:2 column:1} end:{line:3 column:1}} text:"\n\n"}
axs[0, 0].annotate(
"", p1, p2, xycoords='figure fraction',
overlay.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")

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
arrow((0.435, 0.25), (0.565, 0.25)) # wspace
arrow((0.1, 0.8), (1, 0.8)) # 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.95, 0.83, "right", ha="center")

arrow((0.25, 0), (0.25, 0.1)) # bottom
arrow((0.75, 0), (0.75, 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")
arrow((0.80, 0.1), (0.8, 1)) # 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.75, 0.95, "top", va="center")
Loading
0