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

[Doc]: Multipage PDF: unclear which backend supports and which does not support attach_note() · Issue #29428 · matplotlib/matplotlib · GitHub

Repository navigation

[Doc]: Multipage PDF: unclear which backend supports and which does not support attach_note() #29428

Description

Documentation Link

https://matplotlib.org/stable/gallery/misc/multipage_pdf.html

Problem

The issue is in the first two paragraphs of the page.

This is a demo of creating a pdf file with several pages, as well as adding metadata and annotations to pdf files.

If you want to use a multipage pdf file using LaTeX, you need to use from matplotlib.backends.backend_pgf import PdfPages. This version however does not support attach_note.

Reading, it is unclear whether "this" in the last sentence refers to pdf backend (as suggested by it being on the page for it) or pgf (as suggested by it being in the paragraph about pgf).

Only after clickking on the hyperlinked attach_note do I have to notice that it is a documentation page for a specific backend (which isn't obvious, being sent to an anchor in the middle of the document without header visible). From there, seeing that pdf has attach_note() I can infer that pgf doesn't. That string of logic is quite long for something that should have been clearly stated.

Suggested improvement

Change "this" to "that" in the last quoted sentence would probably make it clearer it is referring to the backend not used in the example. Or perhaps a different change in wording.

Activity

  1. Khushikela29 commented on Jan 9, 2025

    Contributor

    I've raised a PR for the issue, check if the results suite your issue

  2. anntzer commented on Jan 9, 2025

    Contributor

    As far as I can see, the note in the docstring regarding latex support is simply wrong and should just be deleted: backend_pdf.PdfPages supports latex just fine. In fact the example showcases just that on page two...

  3. Khushikela29 commented on Jan 9, 2025

    Contributor

    So should I just remove the sentence ?

  4. anntzer commented on Jan 9, 2025

    Contributor

    Yes.

  5. added this to the v3.11.0 milestone on Jan 11, 2025
  6. added a commit that references this issue on Jan 11, 2025
    685ea2b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions


      Back | FazBrowse Home | New Git URL