The PR fixes the issue[Doc]: Multipage PDF: unclear which backend supports and which does not support attach_note() #29428. This pull request clarifies the backend support for the attach_note feature in the multipage_pdf example documentation.
The original documentation was unclear about which backend supports the attach_note feature. The use of the word "this" in the documentation created ambiguity, as it wasn't clear whether it referred to the PDF backend or the PGF backend.
The wording in the documentation has been updated to ensure that users can quickly and easily understand the backend support for the attach_note feature without needing to infer it through multiple clicks and context clues.

PR checklist

Closes #0000: This PR is linked to the issue regarding the unclear documentation on backend support for attach_note.
[N/A] New and changed code is tested: Not applicable as this is a documentation-only change.
[N/A] Plotting related features are demonstrated in an example: Not applicable as this is a documentation-only change.
[N/A] New Features and API Changes are noted with a directive and release note: Not applicable as this is a documentation-only change.
Documentation complies with general and docstring guidelines: The updated documentation complies with the guidelines specified in the Matplotlib documentation standards.

Clarify backend support for attach_note in multipage PDF example

e7a1db8

github-actionsbot added the Documentation: examplesfiles in galleries/examples label

Jan 8, 2025

github-actionsbot reviewed

Jan 8, 2025

View reviewed changes

Copy link

github-actionsbot left a comment

Choose a reason for hiding this comment

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

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join uson gitter for real-time discussion.

For details on testing, writing docs, and our review process, please seethe developer guide

We strive to be a welcoming and open project. Please follow ourCode of Conduct.

Copy link

jaskij commentedJan 9, 2025•
edited
Loading

Feels like you went a little over the top being explicit, but yes, this absolutely works.

Copy link

Member

tacaswell commentedJan 9, 2025•
edited
Loading

Thank you for your work on this.

The doc failures are real. In rst single back-ticks are "please make this a cross reference".

~~👍 to clarification but the docs and trailing whitespace issues need to be fixed.~~ as pointed out in the linked issue the comment is wrong.

tacaswell added this to thev3.11.0 milestone

Jan 9, 2025

Copy link

Member

rcomer commentedJan 9, 2025

Does this also need updating following the discussion with@anntzer on the issue?

Copy link

Member

tacaswell commentedJan 9, 2025

Yes!

Copy link

ContributorAuthor

Khushikela29 commentedJan 10, 2025

@tacaswell am I suppose to do changes? or this PR works ?

Copy link

Member

tacaswell commentedJan 10, 2025

Per the discussion in#29428 my understanding is we don't need to clarify this note, we can just remove it.

Once that change is made, the docs need to build cleanly (which currently they are not).

Copy link

ContributorAuthor

Khushikela29 commentedJan 10, 2025

okay, I'll remove it

Removed the sentence

6783178

Copy link

ContributorAuthor

Khushikela29 commentedJan 11, 2025

I've removed the sentence in the doc, if you need further changes you can tell me

rcomer linked an issue

Jan 11, 2025

that may beclosed by this pull request

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

Closed

rcomer changed the title~~Fixes #29428 : Clarify backend support for attach_note in multipage PDF example~~Fixes #29428 : Remove erroneous statement in multipage PDF example

Jan 11, 2025