DOC: add more cross-ref and explanatory image #25109
Conversation
2a272e1 to
888e90f
Compare
888e90f to
7569a5e
Compare
|
I'll ping for a review on this. I think the image is helpful - if someone wants to add a different image later that they think is more helpful, that is fine. The standard for doc changes is not "is this exactly what I would do?" but rather "is this an improvement?". |
7569a5e to
88486b3
Compare
doc/users/explain/figures.rst
Outdated
| @@ -39,7 +49,15 @@ that renders Notebooks (PyCharm, VSCode, etc), then they have a backend that | |||
| will render the Matplotlib Figure when a code cell is executed. One thing to | |||
| be aware of is that the default Jupyter backend (``%matplotlib inline``) will | |||
| by default trim or expand the figure size to have a tight box around Artists | |||
| added to the Figure (see :ref:`saving_figures`, below). | |||
| added to the Figure (see :ref:`saving_figures`, below). If you use one of the | |||
| non-default backends you will likely need to use an ipython "magic" like | |||
There was a problem hiding this comment.
can you add a link to the list of default backends here?
There was a problem hiding this comment.
I'm not sure what list of "default backends" you are referring to?
There was a problem hiding this comment.
I was thinking our backend list but you're specifically talking about the default Jupyter backend here so scratch that comment and maybe instead state jupyter inline (default) backend
f704164 to
951d148
Compare
|
New version just uses three separate screenshots in each section.... |
|
Oh that's so much better! I like it a lot. :) |
951d148 to
432b60e
Compare
doc/users/explain/figures.rst
Outdated
| @@ -39,7 +49,15 @@ that renders Notebooks (PyCharm, VSCode, etc), then they have a backend that | |||
| will render the Matplotlib Figure when a code cell is executed. One thing to | |||
| be aware of is that the default Jupyter backend (``%matplotlib inline``) will | |||
| by default trim or expand the figure size to have a tight box around Artists | |||
| added to the Figure (see :ref:`saving_figures`, below). | |||
| added to the Figure (see :ref:`saving_figures`, below). If you use one of the | |||
| non-default backends you will likely need to use an ipython "magic" like | |||
There was a problem hiding this comment.
I was thinking our backend list but you're specifically talking about the default Jupyter backend here so scratch that comment and maybe instead state jupyter inline (default) backend
432b60e to
4f12d48
Compare
|
@meeseeksdev backport to v3.7.0-doc |
|
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
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 If these instructions are inaccurate, feel free to suggest an improvement. |
DOC: add more cross-ref and explanatory image (cherry picked from commit 76dd07e)
* Merge pull request #25109 from jklymak/doc-figure-cross-ref DOC: add more cross-ref and explanatory image (cherry picked from commit 76dd07e) * Backport PR #25109: DOC: add more cross-ref and explanatory image --------- Co-authored-by: hannah <[email protected]>
PR Summary
This adds a bit more cross referencing to figure. Also improves
figures.rstby adding an image showing backends in action ...PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst