Skip to content
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.

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

DOC: update tight layout guide with set_in_layout #18100

Merged
merged 2 commits into from
Jul 29, 2020

Conversation

jklymak
Copy link
Member

@jklymak jklymak commented Jul 28, 2020

PR Summary

The tight layout guide was obsolete with respect to what artists are automatically included in the layout calc...

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/next_api_changes/* if API changed in a backward-incompatible way

@jklymak
Copy link
Member Author

jklymak commented Jul 28, 2020

The CI issues are not this PR (see #18101). The built docs for this PR are here: https://42418-1385122-gh.circle-artifacts.com/0/doc/build/html/tutorials/intermediate/tight_layout_guide.html#caveats

@QuLogic
Copy link
Member

QuLogic commented Jul 28, 2020

I think it's indented too much (and thus in a blockquote); can you remove the extra first space?

# labels, and titles. Thus, other artists may be clipped and also may
# overlap.
# * :func:`~matplotlib.pyplot.tight_layout` by default considers all artists
# on the axes. To remove an artist from the layout calculation you can call
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# on the axes. To remove an artist from the layout calculation you can call
# on the Axes. To remove an artist from the layout calculation you can call

tutorials/intermediate/tight_layout_guide.py Outdated Show resolved Hide resolved
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.

Modulo changes requested by @QuLogic .

@jklymak
Copy link
Member Author

jklymak commented Jul 29, 2020

@timhoffm timhoffm merged commit 8a3ec2f into matplotlib:master Jul 29, 2020
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jul 29, 2020
QuLogic added a commit that referenced this pull request Jul 29, 2020
…100-on-v3.3.0-doc

Backport PR #18100 on branch v3.3.0-doc (DOC: update tight layout guide with set_in_layout)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adding Text Annotation when Co-plotting Shrinks Subplots when Tight Layout is Applied
3 participants