Repository navigation
Conversation
Without a layout engine, Figure.subfigures documents that unspecified wspace/hspace is zero. GridSpec still substitutes figure.subplot.* rc defaults (0.2) for None, so setting only wspace applied a vertical gap from the default hspace (and vice versa). Coerce missing spacings to 0.0 when no layout engine is active. Fixes matplotlib#32076.
|
Thank you for opening your first PR into Matplotlib! If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks. We also ask that you please finish addressing any review comments on this PR and wait for it to be merged (or closed) before opening a new one, as it can be a valuable learning experience to go through the review process. You can also join us on discourse chat for real-time discussion. For details on testing, writing docs, and our review process, please see the developer guide. We strive to be a welcoming and open project. Please follow our Code of Conduct. |
|
This PR shows indications of having been generated by AI. Please check it against our policy and, if it complies, update the PR summary to use our template. |
|
⏰ This pull request might be automatically closed in two weeks from now. Thank you for your contribution to Matplotlib and for the effort you have put into this PR. This pull request does not yet meet the quality and clarity standards needed for an effective review. Project maintainers have limited time for code reviews, and our goal is to prioritize well-prepared contributions to keep Matplotlib maintainable. Matplotlib maintainers cannot provide one-to-one guidance on this PR. However, if you ask focused, well-researched questions, a community member may be willing to help. 💬 To increase the chance of a productive review:
As the author, you are responsible for driving this PR, which entails doing necessary background research as well as presenting its context and your thought process. If you are a new contributor, or do not know how to fulfill these requirements, we recommend that you familiarize yourself with Matplotlib's development conventions or engage with the community via our Discourse or one of our meetings before submitting code. If you substantially improve this PR within two weeks, leave a comment and a team member may remove the |
|
@rcomer Thanks for the flag — I’ve updated this PR to the current template and added an AI Disclosure section consistent with https://matplotlib.org/devdocs/devel/contribute.html#use-of-generative-ai. Short version of the human side of the work:
On the issue you also noted that passing Note on duplicates: #32098 (opened two days after this one) implements essentially the same coerce-to-zero approach. Happy to close in favor of that PR, or keep this one — whichever is easier for review. I won’t open further matplotlib PRs while this is in flight. |
|
Closing this PR. Thanks for the time on the review flag — I will not pursue this change further here. |
PR summary
Without a layout engine,
Figure.subfiguresdocuments that unspecifiedwspace/hspacemeans zero.GridSpecstill substitutesfigure.subplot.{w,h}spacerc defaults (typically0.2) when givenNone, so:subfigures(..., wspace=0.2, hspace=None)incorrectly added a vertical gapsubfigures(..., wspace=None, hspace=0.2)incorrectly added a horizontal gapThis is the regression reported in #32076 (related to the post-#25960 path).
Why this change: the docstring already promises “zero if not using a layout engine.” Passing only one spacing currently violates that for the unspecified axis. Explicit
hspace=0works as a workaround (as @rcomer noted on the issue), but the documented default should hold without requiring both arguments.Implementation: when
self.get_layout_engine() is None, coerce missingwspace/hspaceto0.0before constructing theGridSpec. Layout-engine paths are unchanged (they still infer from rc / the engine).Minimal example (bug on main):
Closes #32076.
AI Disclosure
I used generative AI assistance for:
subfigures/GridSpeccall path and drafting an initial patch sketchI personally reproduced the bug on main (Agg), chose the coerce-to-
0.0location to match the existing docstring, wrote/adjusted the regression test (test_subfigures_partial_spacing_none_is_zero), and verified red→green locally (height 181.82 → 200.0 for the issue reproducer; existingtest_subfigures_wspace_hspacestill passes). I am responsible for the change and can follow up on review.Policy read: https://matplotlib.org/devdocs/devel/contribute.html#use-of-generative-ai
PR checklist