Updates the galleries/tutorials/artists.py file in response to issue #28920
#29080
Conversation
There was a problem hiding this comment.
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.
galleries/tutorials/artists.py
Outdated
| # stored as member variables :attr:`!Figure.patch | ||
| # <matplotlib.figure.Figure.patch>` and :attr:`!Axes.patch | ||
| # <matplotlib.axes.Axes.patch>` ("Patch" is a name inherited from |
There was a problem hiding this comment.
| # stored as member variables :attr:`!Figure.patch | |
| # <matplotlib.figure.Figure.patch>` and :attr:`!Axes.patch | |
| # <matplotlib.axes.Axes.patch>` ("Patch" is a name inherited from | |
| # stored as member variables :attr:`!Figure.patch` and | |
| # :attr:`!Axes.patch` ("Patch" is a name inherited from |
The explicit targets are not needed when we don't link and actually would render verbatim. Compare this
to the original
Please update all other occurences accoringly as well.
Ping @story645. This is something to be aware of for similar PRs.
| @@ -11,15 +11,15 @@ | |||
|
|
|||
| There are three layers to the Matplotlib API. | |||
|
|
|||
| * the :class:`matplotlib.backend_bases.FigureCanvas` is the area onto which | |||
| * the :class:`!matplotlib.backend_bases.FigureCanvas` is the area onto which | |||
There was a problem hiding this comment.
Actually, the previous way of expression is not exactly great - there is just no class
matplotlib.backend_bases.FigureCanvas. We have a logical concept of FigureCanvas that's realized through the subclasses of FigureCanvasBase. Maybe
| * the :class:`!matplotlib.backend_bases.FigureCanvas` is the area onto which | |
| * the *FigureCanvas* (subclasses of `.FigureCanvasBase`) is the area onto which |
And subsequently only use FigureCanvas as a given name (for the logical concept) without further highlighting.
Or better, switch to :term:`FigureCanvas` , but that'd require first setting up a gloassary #28889.
But we can also leave all this for later.
| the figure is drawn | ||
| * the :class:`matplotlib.backend_bases.Renderer` is the object which knows how | ||
| to draw on the :class:`~matplotlib.backend_bases.FigureCanvas` | ||
| * the :class:`!matplotlib.backend_bases.Renderer` is the object which knows how |
There was a problem hiding this comment.
Same issue as above: Renderer is a concept realized through the subclasses of RendererBase.
…s.py` file in response to issue matplotlib#28920
|
Thanks @focardozom |
PR summary
This pull request addresses issue #28920 by updating the
galleries/tutorials/artists.pyfile to allow suppressing missing references using a!prefix, rather than themissing_referencesextension.PR checklist
galleries/tutorials/artists.pyfile in response to issue #28920.