Skip to content

Fixing Matplotlib Notebook Text #27165

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 4 commits into from
Oct 31, 2023
Merged

Fixing Matplotlib Notebook Text #27165

merged 4 commits into from
Oct 31, 2023

Conversation

mattymo30
Copy link
Contributor

PR summary

Following issue #27144, this PR updated the suggested improvement to include the classic notebook versions in the documentation. I also made some changes to the writing of the section and simplifying the text.

PR checklist

you can use:

.. sourcecode:: ipython

Copy link
Member

Choose a reason for hiding this comment

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

This is empty

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated this similar to what's inside figure_intro.rst

@@ -365,8 +356,18 @@ If you only need to use the classic notebook, you can use
which uses the `.backend_nbagg` backend provided by Matplotlib;
however, nbagg does not work in Jupyter Lab.

.. note::
Copy link
Member

Choose a reason for hiding this comment

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

I'd say this section could still be improved a lot, but no need to do it in this PR if you don't have ideas about fixing it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Currently don't have any ideas on improving this section, but I can definitely put some thought into it and make a new PR for it later?

notebook when the cell is executed. Because the images are static, they
cannot be panned / zoomed, take user input, or be updated from other
cells.
==============================
Copy link
Member

Choose a reason for hiding this comment

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

I disagree with changing the level of the headings here, I think Jupyter is actually intended to be underneath the Other Python Prompts banner... And now it looks like Spyder/Other IDEs is underneath Jupyter Notebooks, which is just incorrect.

@@ -73,6 +73,15 @@ other than the default "inline" backend, you will likely need to use an ipython
.. seealso::
:ref:`interactive_figures`.

.. note::

If you only need to use the classic notebook (i.e. `notebook<7`),
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
If you only need to use the classic notebook (i.e. `notebook<7`),
If you only need to use the classic notebook (i.e. ``notebook<7``),

If you want this to show up in code style, it needs to be double backtick, otherwise it treats it as a reference, which is failing the doc build.

@@ -356,7 +347,7 @@ If ``ipympl`` is installed use the magic:

to select and enable it.

If you only need to use the classic notebook, you can use
If you only need to use the classic notebook (i.e. `notebook<7`), you can use
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
If you only need to use the classic notebook (i.e. `notebook<7`), you can use
If you only need to use the classic notebook (i.e. ``notebook<7``), you can use

@ksunden ksunden added this to the v3.8.1 milestone Oct 30, 2023
@ksunden
Copy link
Member

ksunden commented Oct 30, 2023

In the interest of getting this in for the 3.8.1 release, I'll go ahead and commit my suggestions here (usually we prefer to afford contributors time to make the revisions)

Edit: except I can't... as this was made from mattymo30/main (@mattymo30 we highly recommend using a feature branch to make changes)

@ksunden ksunden modified the milestones: v3.8.1, v3.8.2 Oct 31, 2023
@mattymo30
Copy link
Contributor Author

In the interest of getting this in for the 3.8.1 release, I'll go ahead and commit my suggestions here (usually we prefer to afford contributors time to make the revisions)

Edit: except I can't... as this was made from mattymo30/main (@mattymo30 we highly recommend using a feature branch to make changes)

My bad on that. I'll make sure I do that next time. For these changes I'll get on it right away

@ksunden ksunden modified the milestones: v3.8.2, v3.8.1 Oct 31, 2023
@ksunden ksunden merged commit 93f5de4 into matplotlib:main Oct 31, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Oct 31, 2023
QuLogic added a commit that referenced this pull request Oct 31, 2023
…165-on-v3.8.x

Backport PR #27165 on branch v3.8.x (Fixing Matplotlib Notebook Text)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants