X Tutup
Skip to content

FIX: improve CL description and remove constrained_layout text#25144

Merged
rcomer merged 1 commit intomatplotlib:mainfrom
jklymak:doc-improve-CL-desc
Feb 8, 2023
Merged

FIX: improve CL description and remove constrained_layout text#25144
rcomer merged 1 commit intomatplotlib:mainfrom
jklymak:doc-improve-CL-desc

Conversation

@jklymak
Copy link
Copy Markdown
Member

@jklymak jklymak commented Feb 3, 2023

PR Summary

Small changes to the opening paragraphs of Constrained layout tutorial. Also stopped referring to it as constrained_layout since we really want people to use layout='constrained'. Improved some cross-links

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

@jklymak jklymak force-pushed the doc-improve-CL-desc branch 3 times, most recently from 1558bbc to 4745eac Compare February 3, 2023 17:45
@jklymak
Copy link
Copy Markdown
Member Author

jklymak commented Feb 3, 2023

New version: https://output.circle-artifacts.com/output/job/5cd094ae-0819-48ae-89ed-c62f9613f42c/artifacts/0/doc/build/html/tutorials/intermediate/constrainedlayout_guide.html#sphx-glr-tutorials-intermediate-constrainedlayout-guide-py

rcomer
rcomer reviewed Feb 4, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@rcomer rcomer left a comment

Choose a reason for hiding this comment

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

Nice improvement to the prose.

I spotted a couple of lines with an extra “#”, which look odd in the rendered docs so might be good to fix while you’re in there.

matplotlib/tutorials/intermediate/constrainedlayout_guide.py

Lines 81 to 82 in 4745eac

# # ``layout="constrained"`` keyword argument will do the adjusting
# # automatically.

Your commit message is unusually terse, which is not a big deal, but I suspect not intentional.

timhoffm
timhoffm reviewed Feb 4, 2023
View reviewed changes
@jklymak jklymak force-pushed the doc-improve-CL-desc branch 2 times, most recently from 6df7706 to 03f1f03 Compare February 5, 2023 00:12
timhoffm
timhoffm reviewed Feb 5, 2023
View reviewed changes
@jklymak jklymak force-pushed the doc-improve-CL-desc branch 2 times, most recently from 9c1d260 to cdf55c0 Compare February 5, 2023 21:19
timhoffm
timhoffm approved these changes Feb 6, 2023
View reviewed changes
Copy link
Copy Markdown
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 suggest to pick up @rcomer's comment: #25144 (review)

But that can also be done in a followup-PR if you don't have capacity. Either way, feel free to self-merge.

@jklymak jklymak force-pushed the doc-improve-CL-desc branch from cdf55c0 to 8a82ac1 Compare February 7, 2023 00:08
@jklymak
Copy link
Copy Markdown
Member Author

jklymak commented Feb 7, 2023

Sorry, I missed that change

@jklymak
Copy link
Copy Markdown
Member Author

jklymak commented Feb 8, 2023

@rcomer is this OK w/ you?

@timhoffm
Copy link
Copy Markdown
Member

timhoffm commented Feb 8, 2023

The double # in lines 81/82 are still there.

@jklymak jklymak force-pushed the doc-improve-CL-desc branch from 8a82ac1 to 7a0657b Compare February 8, 2023 05:19
@jklymak
Copy link
Copy Markdown
Member Author

jklymak commented Feb 8, 2023

🐑

@rcomer rcomer merged commit 29dcb5c into matplotlib:main Feb 8, 2023
@rcomer
Copy link
Copy Markdown
Member

rcomer commented Feb 8, 2023

Ooops, forgot to pick a milestone. Should this be backported?

@jklymak
Copy link
Copy Markdown
Member Author

jklymak commented Feb 8, 2023

@meeseeksdev backport to v3.7.x

@jklymak jklymak deleted the doc-improve-CL-desc branch February 8, 2023 14:55
@lumberbot-app
Copy link
Copy Markdown

lumberbot-app bot commented Feb 8, 2023

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.7.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 29dcb5c1e68735e7896ebef8cd7114fd9a133d7f
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #25144: FIX: improve CL description and remove constrained_layout text'
  1. Push to a named branch:
git push YOURFORK v3.7.x:auto-backport-of-pr-25144-on-v3.7.x
  1. Create a PR against branch v3.7.x, I would have named this PR:

"Backport PR #25144 on branch v3.7.x (FIX: improve CL description and remove constrained_layout text)"

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
Copy Markdown
Member Author

jklymak commented Feb 8, 2023

Bah, not worth a manual backport ;-)

@jklymak jklymak added this to the v3.7.1 milestone Feb 8, 2023
@jklymak jklymak modified the milestones: v3.7.1, v3.8.0 Feb 8, 2023
@rcomer rcomer mentioned this pull request Feb 11, 2023
Merged
6 tasks
@rcomer rcomer mentioned this pull request Feb 18, 2023
Merged
6 tasks
@rcomer rcomer mentioned this pull request Feb 27, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@timhoffm timhoffm timhoffm approved these changes

@rcomer rcomer rcomer approved these changes

Assignees

No one assigned

Labels

Documentation

Projects

None yet

Milestone

v3.8.0

Development

Successfully merging this pull request may close these issues.

3 participants

@jklymak @timhoffm @rcomer
X Tutup