Skip to content

Shorten PdfPages FAQ entry. #21229

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

Merged
merged 1 commit into from
Sep 30, 2021
Merged

Shorten PdfPages FAQ entry. #21229

merged 1 commit into from
Sep 30, 2021

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Sep 30, 2021

The original wording was inaccurate as both the pdf and pgf backends
provide this functionality. I tried fixing that, but duplicating all
links to both backends seemed unwieldy; additionally the "narrative"
version of the FAQ reads worse (we should just encourage pp.savefig()
instead of explaining that plt.savefig() needs workarounds, and also
prefer with PdfPages(...) as pp:). Given that the docstring of both
classes have examples, I just got rid of most of the FAQ entry instead
(see also the next FAQ entries, which also have no code).

PR Summary

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • 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).

The original wording was inaccurate as both the pdf and pgf backends
provide this functionality.  I tried fixing that, but duplicating all
links to both backends seemed unwieldy; additionally the "narrative"
version of the FAQ reads worse (we should just encourage `pp.savefig()`
instead of explaining that `plt.savefig()` needs workarounds, and also
prefer `with PdfPages(...) as pp:`).  Given that the docstring of both
classes have examples, I just got rid of most of the FAQ entry instead
(see also the next FAQ entries, which also have no code).
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 think the PdfPages / PgfPages docstring would benefit from a small full example. But that can be another PR. This is an improvement as is.

@timhoffm timhoffm added this to the v3.5.0 milestone Sep 30, 2021
@timhoffm timhoffm merged commit 1a040b2 into matplotlib:master Sep 30, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 30, 2021
@anntzer anntzer deleted the pdfpages branch September 30, 2021 11:47
timhoffm added a commit that referenced this pull request Sep 30, 2021
…229-on-v3.5.x

Backport PR #21229 on branch v3.5.x (Shorten PdfPages FAQ entry.)
tacaswell pushed a commit to tacaswell/matplotlib that referenced this pull request Oct 12, 2021
tacaswell pushed a commit that referenced this pull request Oct 20, 2021
Shorten PdfPages FAQ entry.
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.

2 participants