FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

DOC: change gridspec tutorial to arranging_axes tutorial by jklymak · Pull Request #21631 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

DOC: change gridspec tutorial to arranging_axes tutorial - #21631

Merged
QuLogic merged 1 commit into
matplotlib:mainfrom
jklymak:doc-update-gridspec-tutorial
Nov 24, 2021
ConversationCommits (1)ChecksFiles changed
Merged

DOC: change gridspec tutorial to arranging_axes tutorial#21631
QuLogic merged 1 commit into
matplotlib:mainfrom
jklymak:doc-update-gridspec-tutorial

Conversation

jklymak commented Nov 14, 2021 •
edited
Loading

Copy link
Copy Markdown
Member

PR Summary

/tutorials/intermediate/gridspec was pretty stale, in particular users almost never need to access gridspec directly anymore with subplot_mosaic and subfigures providing higher-level interfaces to those features. I also moved the tutorial to a new name arranging_axes instead of gridspec since the tutorial is now more general.

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

jklymak changed the title DOC: modernize gridspec tutorial DOC: change gridspec tutorial to arranging_axes tutorial Nov 14, 2021

jklymak commented Nov 14, 2021

Copy link
Copy Markdown
Member Author

I have to fix a link but this will likely require other revision so I'll open to review.

jklymak marked this pull request as ready for review November 14, 2021 13:16
jklymak added Documentation topic: geometry manager LayoutEngine, Constrained layout, Tight layout labels Nov 14, 2021
jklymak force-pushed the doc-update-gridspec-tutorial branch from fbd9161 to f99590c Compare November 14, 2021 20:41
timhoffm reviewed Nov 15, 2021
View reviewed changes

timhoffm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@jklymak It's great that you take this on! 👍 I've only managed to review the "High-level methods for making grids", but I think that part of feedback is already actionable and you can respond before/while I review the rest.

Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
jklymak force-pushed the doc-update-gridspec-tutorial branch from 286efc0 to 63054c2 Compare November 15, 2021 09:33
timhoffm reviewed Nov 15, 2021
View reviewed changes
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
jklymak force-pushed the doc-update-gridspec-tutorial branch from 8ddc371 to 2a91cdb Compare November 16, 2021 09:30
jklymak mentioned this pull request Nov 16, 2021
Merged
6 tasks
timhoffm reviewed Nov 16, 2021
View reviewed changes

timhoffm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I'm happy with the High-level part! :) will have a look at the other topics later.

Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
jklymak force-pushed the doc-update-gridspec-tutorial branch from 51f364a to 01098ac Compare November 16, 2021 16:22
timhoffm reviewed Nov 16, 2021
View reviewed changes
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
jklymak force-pushed the doc-update-gridspec-tutorial branch from f35a501 to 524e27f Compare November 17, 2021 08:21
jklymak added this to the v3.5-doc milestone Nov 17, 2021
timhoffm reviewed Nov 17, 2021
View reviewed changes
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
jklymak force-pushed the doc-update-gridspec-tutorial branch from 9a7e915 to 94c643b Compare November 18, 2021 09:10
timhoffm reviewed Nov 18, 2021
View reviewed changes
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
jklymak force-pushed the doc-update-gridspec-tutorial branch from 94c643b to 4e3cdce Compare November 19, 2021 07:18
QuLogic reviewed Nov 23, 2021
View reviewed changes
Comment thread tutorials/intermediate/arranging_axes.py
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
jklymak force-pushed the doc-update-gridspec-tutorial branch from c00b89a to 8be6678 Compare November 23, 2021 10:10
timhoffm approved these changes Nov 23, 2021
View reviewed changes

timhoffm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

This is good modulo handling @QuLogic's comments.

jklymak force-pushed the doc-update-gridspec-tutorial branch from 8be6678 to 5c1f4d2 Compare November 24, 2021 08:32
QuLogic reviewed Nov 24, 2021
View reviewed changes
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
Comment thread tutorials/intermediate/arranging_axes.py Outdated
DOC: modernize gridspec tutorial
81440be 
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
jklymak force-pushed the doc-update-gridspec-tutorial branch from 5c1f4d2 to 81440be Compare November 24, 2021 09:34
QuLogic merged commit 756d1d4 into matplotlib:main Nov 24, 2021

lumberbot-app Bot commented Nov 24, 2021

Copy link
Copy Markdown

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.5.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -m1 756d1d462052db5fc115faf6535427b72344b193
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #21631: DOC: change gridspec tutorial to arranging_axes tutorial'
  1. Push to a named branch:
git push YOURFORK v3.5.x:auto-backport-of-pr-21631-on-v3.5.x
  1. Create a PR against branch v3.5.x, I would have named this PR:

"Backport PR #21631 on branch v3.5.x (DOC: change gridspec tutorial to arranging_axes tutorial)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

QuLogic added a commit that referenced this pull request Nov 27, 2021
Merge pull request #21770 from jklymak/auto-backport-of-pr-21631-on-v…
f03f8be 
…3.5.x

Backport of PR #21631 on v3.5.x
QuLogic added a commit to QuLogic/matplotlib that referenced this pull request Dec 1, 2021
Revert backport of matplotlib#21631 to v3.5.0-doc
3a02604 
This PR renames a tutorial, and thus needs to updtae a link in a .py
file. Changes to .py files have no effect on the -doc branch, because it
is run against the released version, so this breaks the build since the
old link is gone.

This reverts commit 37131e9.
QuLogic added a commit to QuLogic/matplotlib that referenced this pull request Dec 1, 2021
Revert backport of matplotlib#21631 to v3.5.0-doc
6f63999 
This PR renames a tutorial, and thus needs to updtae a link in a .py
file. Changes to .py files have no effect on the -doc branch, because it
is run against the released version, so this breaks the build since the
old link is gone.

This reverts commit 37131e9.
QuLogic mentioned this pull request Dec 1, 2021
Merged
2 tasks done
QuLogic added a commit that referenced this pull request Dec 3, 2021
Merge pull request #21824 from QuLogic/v3.5.0-doc
db35fd7 
Revert backport of #21631 to v3.5.0-doc
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
d2726c3 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
592850c 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Revert backport of matplotlib#21631 to v3.5.0-doc
4a27ae6 
This PR renames a tutorial, and thus needs to updtae a link in a .py
file. Changes to .py files have no effect on the -doc branch, because it
is run against the released version, so this breaks the build since the
old link is gone.

This reverts commit 37131e9.
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
862a52d 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
004de1a 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Revert backport of matplotlib#21631 to v3.5.0-doc
407686a 
This PR renames a tutorial, and thus needs to updtae a link in a .py
file. Changes to .py files have no effect on the -doc branch, because it
is run against the released version, so this breaks the build since the
old link is gone.

This reverts commit 37131e9.
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
0dc2861 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
898ee3c 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Revert backport of matplotlib#21631 to v3.5.0-doc
d547634 
This PR renames a tutorial, and thus needs to updtae a link in a .py
file. Changes to .py files have no effect on the -doc branch, because it
is run against the released version, so this breaks the build since the
old link is gone.

This reverts commit 37131e9.
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
f4c16e5 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Revert backport of matplotlib#21631 to v3.5.0-doc
e9e5f3b 
This PR renames a tutorial, and thus needs to updtae a link in a .py
file. Changes to .py files have no effect on the -doc branch, because it
is run against the released version, so this breaks the build since the
old link is gone.

This reverts commit 37131e9.
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
853b252 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Revert backport of matplotlib#21631 to v3.5.0-doc
9245460 
This PR renames a tutorial, and thus needs to updtae a link in a .py
file. Changes to .py files have no effect on the -doc branch, because it
is run against the released version, so this breaks the build since the
old link is gone.

This reverts commit 37131e9.
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
b62a37a 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Revert backport of matplotlib#21631 to v3.5.0-doc
72aed39 
This PR renames a tutorial, and thus needs to updtae a link in a .py
file. Changes to .py files have no effect on the -doc branch, because it
is run against the released version, so this breaks the build since the
old link is gone.

This reverts commit 37131e9.
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
233a651 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Revert backport of matplotlib#21631 to v3.5.0-doc
381847e 
This PR renames a tutorial, and thus needs to updtae a link in a .py
file. Changes to .py files have no effect on the -doc branch, because it
is run against the released version, so this breaks the build since the
old link is gone.

This reverts commit 37131e9.
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
fdd8a14 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Revert backport of matplotlib#21631 to v3.5.0-doc
22e9ae8 
This PR renames a tutorial, and thus needs to updtae a link in a .py
file. Changes to .py files have no effect on the -doc branch, because it
is run against the released version, so this breaks the build since the
old link is gone.

This reverts commit 37131e9.
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
8305885 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Revert backport of matplotlib#21631 to v3.5.0-doc
fffaa4e 
This PR renames a tutorial, and thus needs to updtae a link in a .py
file. Changes to .py files have no effect on the -doc branch, because it
is run against the released version, so this breaks the build since the
old link is gone.

This reverts commit 37131e9.
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
e54f591 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Revert backport of matplotlib#21631 to v3.5.0-doc
b7f4642 
This PR renames a tutorial, and thus needs to updtae a link in a .py
file. Changes to .py files have no effect on the -doc branch, because it
is run against the released version, so this breaks the build since the
old link is gone.

This reverts commit 37131e9.
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
67bb722 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Revert backport of matplotlib#21631 to v3.5.0-doc
88efe25 
This PR renames a tutorial, and thus needs to updtae a link in a .py
file. Changes to .py files have no effect on the -doc branch, because it
is run against the released version, so this breaks the build since the
old link is gone.

This reverts commit 37131e9.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

QuLogic QuLogic approved these changes
timhoffm timhoffm approved these changes

Assignees

No one assigned

Labels

Documentation topic: geometry manager LayoutEngine, Constrained layout, Tight layout

Projects

None yet

Milestone

v3.6.0

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL