8000 Fixes #29428 : Remove erroneous statement in multipage PDF example by Khushikela29 · Pull Request #29433 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Fixes #29428 : Remove erroneous statement in multipage PDF example #29433

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jan 11, 2025
Merged

Fixes #29428 : Remove erroneous statement in multipage PDF example #29433

merged 2 commits into from
Jan 11, 2025

Conversation

Khushikela29
Copy link
Contributor
@Khushikela29 Khushikela29 commented Jan 8, 2025 •
edited
Loading

PR summary

  • 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.

@github-actions github-actions bot added the Documentation: examples files in galleries/examples label Jan 8, 2025
github-actions[bot]
github-actions bot reviewed Jan 8, 2025
View reviewed changes
Copy link
@github-actions github-actions bot 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 us on gitter for real-time discussion.

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

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

@jaskij
Copy link
jaskij commented Jan 9, 2025 •
edited
Loading

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

@tacaswell
Copy link
Member
tacaswell commented Jan 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 tacaswell added this to the v3.11.0 milestone Jan 9, 2025
@rcomer
Copy link
Member
rcomer commented Jan 9, 2025

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

@tacaswell
Copy link
Member

Yes!

@Khushikela29
Copy link
Contributor Author

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

@tacaswell
Copy link
Member

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).

@Khushikela29
Copy link
Contributor Author

okay, I'll remove it

@Khushikela29
Copy link
Contributor Author

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

@rcomer rcomer linked an issue Jan 11, 2025 that may be closed by this pull request
[Doc]: Multipage PDF: unclear which backend supports and which does not support attach_note() #29428
Closed
@rcomer 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
@rcomer rcomer merged commit 685ea2b into matplotlib:main Jan 11, 2025
22 checks passed
@rcomer
Copy link
Member
rcomer commented Jan 11, 2025

Thanks @Khushikela29 and congratulations on you first Matplotlib PR! 🎉

@Khushikela29
Copy link
Contributor Author

Thankyou !! How can I contribute more to the repository can you guide me ?

@rcomer
Copy link
Member
rcomer commented Jan 11, 2025

@Khushikela29 please have a look at our Contributors’ Guide here:
https://matplotlib.org/devdocs/devel/index

@timhoffm timhoffm mentioned this pull request Jan 12, 2025
Merged
2 tasks
@QuLogic QuLogic mentioned this pull request Jan 15, 2025
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@rcomer rcomer rcomer approved these changes

Assignees
No one assigned
Labels
Documentation: examples files in galleries/examples
Projects
First Time Contributors
Status: Merged
Milestone
v3.11.0
Development

Successfully merging this pull request may close these issues.

[Doc]: Multipage PDF: unclear which backend supports and which does not support attach_note()
4 participants
@Khushikela29 @jaskij @tacaswell @rcomer
0