Skip to content

DOC: change gridspec tutorial to arranging_axes tutorial #21631

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

Jump to bottom
Merged
merged 1 commit into from
Nov 24, 2021
Merged

DOC: change gridspec tutorial to arranging_axes tutorial #21631

merged 1 commit into from
Nov 24, 2021

Conversation

jklymak
Copy link
Member

@jklymak jklymak commented Nov 14, 2021 •
edited
Loading

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 jklymak changed the title DOC: modernize gridspec tutorial DOC: change gridspec tutorial to arranging_axes tutorial Nov 14, 2021
@jklymak
Copy link
Member Author

jklymak commented Nov 14, 2021

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

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

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

@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.

@jklymak jklymak force-pushed the doc-update-gridspec-tutorial branch from 286efc0 to 63054c2 Compare November 15, 2021 09:33
timhoffm
timhoffm reviewed Nov 15, 2021
View reviewed changes
@jklymak jklymak force-pushed the doc-update-gridspec-tutorial branch from 8ddc371 to 2a91cdb Compare November 16, 2021 09:30
@jklymak jklymak mentioned this pull request Nov 16, 2021
Merged
6 tasks
timhoffm
timhoffm reviewed Nov 16, 2021
View reviewed changes
Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

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

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

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

This is good modulo handling @QuLogic's comments.

@jklymak jklymak force-pushed the doc-update-gridspec-tutorial branch from 8be6678 to 5c1f4d2 Compare November 24, 2021 08:32
QuLogic
QuLogic reviewed Nov 24, 2021
View reviewed changes
@jklymak @timhoffm @QuLogic
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 jklymak force-pushed the doc-update-gridspec-tutorial branch from 5c1f4d2 to 81440be Compare November 24, 2021 09:34
@QuLogic QuLogic merged commit 756d1d4 into matplotlib:main Nov 24, 2021
@lumberbot-app
Copy link

lumberbot-app bot commented Nov 24, 2021

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.

@jklymak jklymak deleted the doc-update-gridspec-tutorial branch November 24, 2021 21:25
@lumberbot-app
Copy link

lumberbot-app bot commented Nov 24, 2021

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.0-doc
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.0-doc:auto-backport-of-pr-21631-on-v3.5.0-doc
  1. Create a PR against branch v3.5.0-doc, I would have named this PR:

"Backport PR #21631 on branch v3.5.0-doc (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.

@jklymak
Copy link
Member Author

jklymak commented Nov 25, 2021

I guess this doesn't need to be back ported...

@jklymak jklymak modified the milestones: v3.5-doc, v3.6.0 Nov 25, 2021
jklymak pushed a commit to jklymak/matplotlib that referenced this pull request Nov 27, 2021
@QuLogic @jklymak
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
f2c5e3f 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
jklymak pushed a commit to jklymak/matplotlib that referenced this pull request Nov 27, 2021
@QuLogic @jklymak
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
a8f8204 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
jklymak pushed a commit to jklymak/matplotlib that referenced this pull request Nov 27, 2021
@QuLogic @jklymak
Merge pull request matplotlib#21631 from jklymak/doc-update-gridspec-…
37131e9 
…tutorial

DOC: change gridspec tutorial to arranging_axes tutorial
QuLogic added a commit that referenced this pull request Nov 27, 2021
@QuLogic
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
@QuLogic
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
@QuLogic
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 QuLogic mentioned this pull request Dec 1, 2021
Merged
2 tasks
QuLogic added a commit that referenced this pull request Dec 3, 2021
@QuLogic
Merge pull request #21824 from QuLogic/v3.5.0-doc
db35fd7 
Revert backport of #21631 to v3.5.0-doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@QuLogic QuLogic QuLogic approved these changes

@timhoffm 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
@jklymak @QuLogic @timhoffm