Skip to content

DOC: Add axis sharing section to subplot_mosaic guide - #31720

Merged
timhoffm merged 2 commits into
matplotlib:mainfrom
Atharva2012:doc-mosaic-access-sharing
May 27, 2026
Merged

DOC: Add axis sharing section to subplot_mosaic guide#31720
timhoffm merged 2 commits into
matplotlib:mainfrom
Atharva2012:doc-mosaic-access-sharing

Conversation

@Atharva2012

@Atharva2012 Atharva2012 commented May 20, 2026

Copy link
Copy Markdown
Contributor

PR summary
Adds a new "Axis sharing" section to the subplot_mosaic user guide (galleries/users_explain/axes/mosaic.py), as requested in #31699 (extracted from #25417).
The section includes:

A basic sharex=True example with "AC;BC" showing standard sharing behavior
A demonstration of the gotcha when combining sharey=True with empty sentinels (".A;BC"), where y-axis tick labels unexpectedly disappear
The tick_params(labelleft=True) workaround to restore them

Closes

#31699

AI Disclosure

None

PR checklist

  • "closes [Doc]: Add a section on axis sharing to subplot_mosaic guide #31699"
  • new and changed code is tested (docs-only change, no new code to test)
  • Plotting related features are demonstrated in an example
  • New Features and API Changes are noted with a directive and release note (not applicable, docs-only)
  • Documentation complies with general and docstring guidelines

@github-actions github-actions Bot added the Documentation: user guide files in galleries/users_explain or doc/users label May 20, 2026
@Atharva2012

Copy link
Copy Markdown
Contributor Author

The docs-python3 CI failure appears to be a pre-existing infrastructure issue — the build fails at requirements/dev/build-requirements.txt not found, before it reaches any documentation content. This is unrelated to my changes.

@story645 story645 added the status: autoclose candidate PRs that are not yet ready for review and may be automatically closed in two weeks label May 21, 2026
@github-actions

Copy link
Copy Markdown

⏰ 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 status: autoclose candidate label and the PR stays open. Cosmetic changes or incomplete fixes will not be sufficient. Maintainers will assess improvements on their own schedule. Please do not ping (@) maintainers.

@story645

story645 commented May 21, 2026

Copy link
Copy Markdown
Member

Hi, thanks for the PR but please fill out the PR template correctly, including the AI disclosure.

@Atharva2012

Copy link
Copy Markdown
Contributor Author

Hello, thank you for the input, I'll make sure everything is in complaisance as soon as possible

@Atharva2012

Copy link
Copy Markdown
Contributor Author

@story645 Thanks for the input, I've made the necessary changes to the best of my knowledge, kindly let me know if there's anything else I need to do.

@timhoffm

Copy link
Copy Markdown
Member

Your branch is based on a very old version of main, likely the cause of the doc build failure. Please rebase.

@Atharva2012
Atharva2012 force-pushed the doc-mosaic-access-sharing branch from 2b9be64 to e402c91 Compare May 24, 2026 17:29
@melissawm melissawm removed the status: autoclose candidate PRs that are not yet ready for review and may be automatically closed in two weeks label May 25, 2026
@Atharva2012

Copy link
Copy Markdown
Contributor Author

@timhoffm rebase done. Let me know what else is required.

Comment thread galleries/users_explain/axes/mosaic.py Outdated
Comment thread galleries/users_explain/axes/mosaic.py Outdated
Comment thread galleries/users_explain/axes/mosaic.py Outdated
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
@Atharva2012

Copy link
Copy Markdown
Contributor Author

@timhoffm Just committed the changes.

@timhoffm timhoffm added this to the v3.11.0 milestone May 27, 2026
@timhoffm
timhoffm merged commit c1a1c8d into matplotlib:main May 27, 2026
21 checks passed
@timhoffm

Copy link
Copy Markdown
Member

Thanks @Atharva2012, and congratulations on your first contribution to matplotlib! 🎉 We hope to see you back.

rcomer added a commit that referenced this pull request May 27, 2026
…720-on-v3.11.x

Backport PR #31720 on branch v3.11.x (DOC: Add axis sharing section to subplot_mosaic guide)
@Atharva2012

Copy link
Copy Markdown
Contributor Author

Thanks @Atharva2012, and congratulations on your first contribution to matplotlib! 🎉 We hope to see you back.
Thanks @timhoffm , Looking forward to being an active contributor.

@QuLogic

QuLogic commented May 29, 2026

Copy link
Copy Markdown
Member

Quick question; is the email address in your first commit correct? It does not appear to be associated with your GitHub account.

@Atharva2012

Copy link
Copy Markdown
Contributor Author

@QuLogic Good catch, it was ".con" instead of ".com". I've corrected it for future commits.
Thanks.

@QuLogic QuLogic mentioned this pull request Jun 4, 2026
1 task
@Atharva2012
Atharva2012 deleted the doc-mosaic-access-sharing branch June 26, 2026 00:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation: user guide files in galleries/users_explain or doc/users

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc]: Add a section on axis sharing to subplot_mosaic guide

5 participants