Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 350ed26

Browse files
committed
DOC: Fix some broken references
1 parent 1f339e8 commit 350ed26

File tree

6 files changed

+7
-24
lines changed

6 files changed

+7
-24
lines changed

doc/missing-references.json

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -337,9 +337,6 @@
337337
"Artist.stale_callback": [
338338
"doc/users/explain/figure/interactive_guide.rst:323"
339339
],
340-
"Artist.sticky_edges": [
341-
"doc/api/axes_api.rst:356:<autosummary>:1"
342-
],
343340
"Axes.dataLim": [
344341
"doc/api/axes_api.rst:293:<autosummary>:1",
345342
"lib/matplotlib/axes/_base.py:docstring of matplotlib.axes._base._AxesBase.update_datalim:2"
@@ -357,9 +354,6 @@
357354
"Image": [
358355
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.gci:4"
359356
],
360-
"ImageComparisonFailure": [
361-
"lib/matplotlib/testing/decorators.py:docstring of matplotlib.testing.decorators.image_comparison:2"
362-
],
363357
"Line2D.pick": [
364358
"doc/users/explain/figure/event_handling.rst:568"
365359
],
@@ -665,29 +659,17 @@
665659
"mpl_toolkits.axislines.Axes": [
666660
"lib/mpl_toolkits/axisartist/axis_artist.py:docstring of mpl_toolkits.axisartist.axis_artist:7"
667661
],
668-
"next_whats_new": [
669-
"doc/users/next_whats_new/README.rst:6"
670-
],
671662
"option_scale_image": [
672663
"lib/matplotlib/backends/backend_cairo.py:docstring of matplotlib.backends.backend_cairo.RendererCairo.draw_image:22",
673664
"lib/matplotlib/backends/backend_pdf.py:docstring of matplotlib.backends.backend_pdf.RendererPdf.draw_image:22",
674665
"lib/matplotlib/backends/backend_ps.py:docstring of matplotlib.backends.backend_ps.RendererPS.draw_image:22",
675666
"lib/matplotlib/backends/backend_template.py:docstring of matplotlib.backends.backend_template.RendererTemplate.draw_image:22"
676667
],
677-
"print_xyz": [
678-
"lib/matplotlib/backends/backend_template.py:docstring of matplotlib.backends.backend_template:22"
679-
],
680668
"toggled": [
681669
"lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.AxisScaleBase.disable:4",
682670
"lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.AxisScaleBase.enable:4",
683671
"lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.AxisScaleBase.trigger:2",
684672
"lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ZoomPanBase.trigger:2"
685-
],
686-
"tool_removed_event": [
687-
"lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.ToolContainerBase.remove_toolitem:6"
688-
],
689-
"whats_new.rst": [
690-
"doc/users/next_whats_new/README.rst:6"
691673
]
692674
}
693675
}

doc/users/next_whats_new/README.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
Instructions for writing "What's new" entries
44
=============================================
55

6-
Please place new portions of `whats_new.rst` in the `next_whats_new` directory.
6+
Please place new portions of :file:`whats_new.rst` in the :file:`next_whats_new`
7+
directory.
78

89
When adding an entry please look at the currently existing files to
910
see if you can extend any of them. If you create a file, name it

lib/matplotlib/axes/_base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2635,7 +2635,7 @@ def set_autoscale_on(self, b):
26352635
@property
26362636
def use_sticky_edges(self):
26372637
"""
2638-
When autoscaling, whether to obey all `Artist.sticky_edges`.
2638+
When autoscaling, whether to obey all `.Artist.sticky_edges`.
26392639
26402640
Default is ``True``.
26412641

lib/matplotlib/backend_bases.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3419,7 +3419,7 @@ def remove_toolitem(self, name):
34193419
34203420
This hook must be implemented in each backend and contains the
34213421
backend-specific code to remove an element from the toolbar; it is
3422-
called when `.ToolManager` emits a `tool_removed_event`.
3422+
called when `.ToolManager` emits a ``tool_removed_event``.
34233423
34243424
Because some tools are present only on the `.ToolManager` but not on
34253425
the `ToolContainer`, this method must be a no-op when called on a tool

lib/matplotlib/backends/backend_template.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
import matplotlib
2121
matplotlib.use("module://my.backend")
2222
23-
If your backend implements support for saving figures (i.e. has a `print_xyz`
24-
method), you can register it as the default handler for a given file type::
23+
If your backend implements support for saving figures (i.e. has a ``print_xyz`` method),
24+
you can register it as the default handler for a given file type::
2525
2626
from matplotlib.backend_bases import register_backend
2727
register_backend('xyz', 'my_backend', 'XYZ File Format')

lib/matplotlib/testing/decorators.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ def image_comparison(baseline_images, extensions=None, tol=0,
263263
style=("classic", "_classic_test_patch")):
264264
"""
265265
Compare images generated by the test with those specified in
266-
*baseline_images*, which must correspond, else an `ImageComparisonFailure`
266+
*baseline_images*, which must correspond, else an `.ImageComparisonFailure`
267267
exception will be raised.
268268
269269
Parameters

0 commit comments

Comments
 (0)