Skip to content

DOC: Remove notebook instructions from image tutorial #30686

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
timhoffm merged 1 commit into from
Oct 27, 2025
Merged

DOC: Remove notebook instructions from image tutorial #30686

timhoffm merged 1 commit into from
Oct 27, 2025

Conversation

@timhoffm
Copy link
Member

@timhoffm timhoffm commented Oct 27, 2025

This information is not needed for the tutorial. For a topic tutorial, we can assume that the user has a working matplotlib setup one way or the other and basically knows how to operate it.

The notebook instructions are also not that specific or valuable that it
would be worth extracting to another place.

Closes #20554.

PR summary

PR checklist

@timhoffm
DOC: Remove notebook instructions from image tutorial
d00a72e 
This information is not needed for the tutorial. For a topic tutorial,
we can assume that the user has a working matplotlib setup one way or
the other and basically knows how to operate it.

The notebook instructions are also not that specific or valuable that it
 would be worth extracting to another place.

Closes matplotlib#20554.
@github-actions github-actions bot added the Documentation: tutorials files in galleries/tutorials label Oct 27, 2025
@story645 story645 added this to the v3.10-doc milestone Oct 27, 2025
@timhoffm
Copy link
Member Author

timhoffm commented Oct 27, 2025

Doc build failure is unrelated and will be fixed in #30687.

@timhoffm timhoffm merged commit e0f0ded into matplotlib:main Oct 27, 2025
18 of 21 checks passed
@timhoffm timhoffm deleted the doc-remove-notebook branch October 27, 2025 16:58
@lumberbot-app
Copy link

lumberbot-app bot commented Oct 27, 2025

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.10.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 e0f0ded0d123c34d70e7399884b42be2da266758
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #30686: DOC: Remove notebook instructions from image tutorial'
  1. Push to a named branch:
git push YOURFORK v3.10.x:auto-backport-of-pr-30686-on-v3.10.x
  1. Create a PR against branch v3.10.x, I would have named this PR:

"Backport PR #30686 on branch v3.10.x (DOC: Remove notebook instructions from image tutorial)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@lumberbot-app
Copy link

lumberbot-app bot commented Oct 27, 2025

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.10.7-doc
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 e0f0ded0d123c34d70e7399884b42be2da266758
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #30686: DOC: Remove notebook instructions from image tutorial'
  1. Push to a named branch:
git push YOURFORK v3.10.7-doc:auto-backport-of-pr-30686-on-v3.10.7-doc
  1. Create a PR against branch v3.10.7-doc, I would have named this PR:

"Backport PR #30686 on branch v3.10.7-doc (DOC: Remove notebook instructions from image tutorial)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@timhoffm
Copy link
Member Author

timhoffm commented Oct 27, 2025

Not worth a manual backport

@QuLogic QuLogic modified the milestones: v3.10-doc, v3.11.0 Oct 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@story645 story645 story645 approved these changes

Assignees

No one assigned

Labels

Documentation: tutorials files in galleries/tutorials

Projects

None yet

Milestone

v3.11.0

Development

Successfully merging this pull request may close these issues.

Remove discussion of jupyter backends from image tutorial

3 participants

@timhoffm @story645 @QuLogic