Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit c61d670

Browse filesBrowse files
committed
Fix some more missing references.
1 parent 4412114 commit c61d670
Copy full SHA for c61d670

File tree

Expand file treeCollapse file tree

6 files changed

+65
-77
lines changed
Filter options
Expand file treeCollapse file tree

6 files changed

+65
-77
lines changed

‎doc/api/cbook_api.rst

Copy file name to clipboardExpand all lines: doc/api/cbook_api.rst
+5Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,8 @@
66
:members:
77
:undoc-members:
88
:show-inheritance:
9+
10+
.. automodule:: matplotlib.cbook.deprecation
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:

‎doc/api/colors_api.rst

Copy file name to clipboardExpand all lines: doc/api/colors_api.rst
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,5 +51,6 @@ Functions
5151
to_rgba
5252
to_rgba_array
5353
is_color_like
54+
same_color
5455
makeMappingArray
5556
get_named_colors_mapping

‎doc/missing-references.json

Copy file name to clipboardExpand all lines: doc/missing-references.json
+44-59Lines changed: 44 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -288,9 +288,6 @@
288288
"matplotlib.cbook.MatplotlibDeprecationWarning": [
289289
"doc/api/prev_api_changes/api_changes_3.0.0.rst:406"
290290
],
291-
"matplotlib.cbook.deprecation.MatplotlibDeprecationWarning": [
292-
"doc/api/prev_api_changes/api_changes_3.0.0.rst:406"
293-
],
294291
"matplotlib.cm.Wistia": [
295292
"doc/users/prev_whats_new/whats_new_1.4.rst:21"
296293
],
@@ -626,7 +623,7 @@
626623
"doc/api/prev_api_changes/api_changes_0.91.0.rst:34"
627624
],
628625
"matplotlib.pylab": [
629-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:624",
626+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:616",
630627
"doc/users/history.rst:63"
631628
],
632629
"matplotlib.tests.test_basic": [
@@ -666,12 +663,12 @@
666663
"lib/matplotlib/axes/_base.py:docstring of matplotlib.axes.Axes.update_datalim_bounds:2"
667664
],
668665
"Axes.fmt_xdata": [
669-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:405",
670-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:408"
666+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:397",
667+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:400"
671668
],
672669
"Axes.fmt_ydata": [
673-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:405",
674-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:408"
670+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:397",
671+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:400"
675672
],
676673
"Axes.transData": [
677674
"doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:89",
@@ -684,14 +681,14 @@
684681
"lib/matplotlib/axes/_base.py:docstring of matplotlib.axes.Axes.add_child_axes:2"
685682
],
686683
"Axis._update_ticks": [
687-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1074"
684+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1066"
688685
],
689686
"Axis.get_inverted": [
690687
"doc/users/prev_whats_new/whats_new_3.1.0.rst:241",
691688
"doc/users/prev_whats_new/whats_new_3.1.0.rst:243"
692689
],
693690
"Axis.remove_overlaping_locs": [
694-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:79"
691+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:71"
695692
],
696693
"Axis.set_inverted": [
697694
"doc/users/prev_whats_new/whats_new_3.1.0.rst:241",
@@ -732,8 +729,8 @@
732729
"doc/devel/MEP/MEP23.rst:87"
733730
],
734731
"Formatter.__call__": [
735-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1123",
736-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1129"
732+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1115",
733+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1121"
737734
],
738735
"GaussianKDE": [
739736
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.violinplot:46",
@@ -752,15 +749,12 @@
752749
"lib/matplotlib/testing/decorators.py:docstring of matplotlib.testing.decorators.image_comparison:2"
753750
],
754751
"ImageComparisonTest": [
755-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:710"
752+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:702"
756753
],
757754
"Legend": [
758755
"doc/api/axes_api.rst:316:<autosummary>:1",
759756
"lib/matplotlib/axes/_base.py:docstring of matplotlib.axes.Axes.get_legend:2"
760757
],
761-
"LinearSegmentedColormaps": [
762-
"lib/matplotlib/colors.py:docstring of matplotlib.colors.makeMappingArray:64"
763-
],
764758
"MatplotlibDeprecationWarning": [
765759
"doc/devel/contributing.rst:306"
766760
],
@@ -789,7 +783,7 @@
789783
"doc/devel/MEP/MEP23.rst:93"
790784
],
791785
"NavigationToolbar2QT.adj_window": [
792-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:969"
786+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:961"
793787
],
794788
"PolyCollection.get_offset": [
795789
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.hexbin:71",
@@ -899,19 +893,19 @@
899893
"doc/users/prev_whats_new/whats_new_3.0.rst:111"
900894
],
901895
"axes3d.Axes3D.xaxis": [
902-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:941"
896+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:933"
903897
],
904898
"axes3d.Axes3D.yaxis": [
905-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:941"
899+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:933"
906900
],
907901
"axes3d.Axes3D.zaxis": [
908-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:941"
902+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:933"
909903
],
910904
"axes_grid1": [
911905
"doc/index.rst:184"
912906
],
913907
"axis.Axis.get_ticks_position": [
914-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:829"
908+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:821"
915909
],
916910
"axisartist": [
917911
"doc/index.rst:184"
@@ -920,44 +914,44 @@
920914
"lib/matplotlib/backends/backend_template.py:docstring of matplotlib.backends.backend_template.RendererTemplate:4"
921915
],
922916
"backend_bases.Timer.add_callback": [
923-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:267"
917+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:259"
924918
],
925919
"backend_bases.Timer.remove_callback": [
926-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:247"
920+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:239"
927921
],
928922
"backend_bases.ToolContainerBase": [
929923
"lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.add_tools_to_container:8"
930924
],
931925
"backend_gtk3.FileChooserDialog": [
932-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:966"
926+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:958"
933927
],
934928
"backend_gtk3.NavigationToolbar2GTK3.get_filechooser": [
935-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:967"
929+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:959"
936930
],
937931
"backend_gtk3.SaveFigureGTK3.get_filechooser": [
938-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:968"
932+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:960"
939933
],
940934
"backend_wx.IDLE_DELAY": [
941-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:970"
935+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:962"
942936
],
943937
"barstacked": [
944938
"doc/users/prev_whats_new/whats_new_1.2.rst:177"
945939
],
946940
"bezier.check_if_parallel": [
947-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:801"
941+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:793"
948942
],
949943
"bezier.find_bezier_t_intersecting_with_closedpath": [
950-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:801"
944+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:793"
951945
],
952946
"bezier.find_r_to_boundary_of_closedpath": [
953-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1026",
954-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:801"
947+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1018",
948+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:793"
955949
],
956950
"bezier.split_bezier_intersecting_with_closedpath": [
957-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:801"
951+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:793"
958952
],
959953
"bezier.split_path_inout": [
960-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:801"
954+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:793"
961955
],
962956
"blocking_input.BlockingInput.__call__": [
963957
"doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst:293"
@@ -979,17 +973,17 @@
979973
"doc/devel/contributing.rst:521"
980974
],
981975
"cbook.deprecated": [
982-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1081",
983-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:774"
976+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:1073",
977+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:766"
984978
],
985979
"cbook.warn_deprecated": [
986-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:774"
980+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:766"
987981
],
988982
"cbook.warn_deprecated()": [
989983
"doc/devel/contributing.rst:309"
990984
],
991985
"collections.LineCollection.get_segements()": [
992-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:288"
986+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:280"
993987
],
994988
"colorbar.ColorbarBase.outline": [
995989
"doc/api/prev_api_changes/api_changes_1.4.x.rst:83"
@@ -998,13 +992,10 @@
998992
"lib/matplotlib/testing/compare.py:docstring of matplotlib.testing.compare.compare_images:4"
999993
],
1000994
"dates.bytespdate2num": [
1001-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:927"
995+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:919"
1002996
],
1003997
"dates.strpdate2num": [
1004-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:926"
1005-
],
1006-
"extend": [
1007-
"lib/matplotlib/colors.py:docstring of matplotlib.colors.from_levels_and_colors:13"
998+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:918"
1008999
],
10091000
"fc-list": [
10101001
"lib/matplotlib/font_manager.py:docstring of matplotlib.font_manager.get_fontconfig_fonts:2"
@@ -1101,7 +1092,7 @@
11011092
"doc/users/prev_whats_new/whats_new_2.0.0.rst:123"
11021093
],
11031094
"legend.Legend.set_draggable()": [
1104-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:507"
1095+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:499"
11051096
],
11061097
"levels": [
11071098
"doc/api/prev_api_changes/api_changes_3.0.0.rst:197"
@@ -1446,16 +1437,13 @@
14461437
"doc/api/prev_api_changes/api_changes_1.5.0.rst:8"
14471438
],
14481439
"matplotlib.colorbar.ColorbarBase.set_clim": [
1449-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:298"
1440+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:290"
14501441
],
14511442
"matplotlib.colorbar.ColorbarBase.set_cmap": [
1452-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:298"
1443+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:290"
14531444
],
14541445
"matplotlib.colorbar.ColorbarBase.set_norm": [
1455-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:298"
1456-
],
1457-
"matplotlib.colors.same_color": [
1458-
"doc/users/prev_whats_new/whats_new_2.2.rst:218"
1446+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:290"
14591447
],
14601448
"matplotlib.contour.TriContourSet": [
14611449
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.tricontour:57",
@@ -1473,10 +1461,10 @@
14731461
"doc/devel/documenting_mpl.rst:671"
14741462
],
14751463
"matplotlib.pylab": [
1476-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:626"
1464+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:618"
14771465
],
14781466
"matplotlib.pyplot.get_scale_docs()": [
1479-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:861"
1467+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:853"
14801468
],
14811469
"matplotlib.sphinxext.mathmpl": [
14821470
"doc/users/prev_whats_new/whats_new_3.0.rst:225"
@@ -1492,10 +1480,10 @@
14921480
"lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.rcdefaults:4"
14931481
],
14941482
"matplotlib.testing.compare.calculate_rms": [
1495-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:779"
1483+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:771"
14961484
],
14971485
"matplotlib.testing.conftest.mpl_test_settings": [
1498-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:949"
1486+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:941"
14991487
],
15001488
"move_canvas": [
15011489
"doc/devel/MEP/MEP23.rst:65"
@@ -1577,8 +1565,8 @@
15771565
"lib/matplotlib/dates.py:docstring of matplotlib.dates:105"
15781566
],
15791567
"scipy.stats.norm.pdf": [
1580-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:573",
1581-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:659"
1568+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:565",
1569+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:651"
15821570
],
15831571
"self.codes": [
15841572
"lib/matplotlib/path.py:docstring of matplotlib.path.Path.codes:2"
@@ -1631,10 +1619,7 @@
16311619
"doc/devel/MEP/MEP10.rst:170"
16321620
],
16331621
"streamplot.Grid": [
1634-
"doc/api/prev_api_changes/api_changes_3.1.0.rst:487"
1635-
],
1636-
"strftime": [
1637-
"lib/matplotlib/dates.py:docstring of matplotlib.dates.ConciseDateFormatter:18"
1622+
"doc/api/prev_api_changes/api_changes_3.1.0.rst:479"
16381623
],
16391624
"style.available": [
16401625
"lib/matplotlib/style/__init__.py:docstring of matplotlib.style.context:12",

‎lib/matplotlib/cbook/deprecation.py

Copy file name to clipboardExpand all lines: lib/matplotlib/cbook/deprecation.py
+10-13Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ class MatplotlibDeprecationWarning(UserWarning):
1717
"""
1818

1919

20+
# mplDeprecation is deprecated. Use MatplotlibDeprecationWarning instead.
2021
mplDeprecation = MatplotlibDeprecationWarning
21-
"""mplDeprecation is deprecated. Use MatplotlibDeprecationWarning instead."""
2222

2323

2424
def _generate_deprecation_warning(
@@ -57,20 +57,18 @@ def warn_deprecated(
5757
since, *, message='', name='', alternative='', pending=False,
5858
obj_type='', addendum='', removal=''):
5959
"""
60-
Used to display deprecation in a standard way.
60+
Display a standardized deprecation.
6161
6262
Parameters
6363
----------
6464
since : str
6565
The release at which this API became deprecated.
6666
6767
message : str, optional
68-
Override the default deprecation message. The format
69-
specifier `%(name)s` may be used for the name of the function,
70-
and `%(alternative)s` may be used in the deprecation message
71-
to insert the name of an alternative to the deprecated
72-
function. `%(obj_type)s` may be used to insert a friendly name
73-
for the type of object being deprecated.
68+
Override the default deprecation message. The ``%(since)s``,
69+
``%(name)s``, ``%(alternative)s``, ``%(obj_type)s``, ``%(addendum)s``,
70+
and ``%(removal)s`` format specifiers will be replaced by the values
71+
of the respective arguments passed to this function.
7472
7573
name : str, optional
7674
The name of the deprecated object.
@@ -127,11 +125,10 @@ def deprecated(since, *, message='', name='', alternative='', pending=False,
127125
The release at which this API became deprecated.
128126
129127
message : str, optional
130-
Override the default deprecation message. The format
131-
specifier `%(name)s` may be used for the name of the object,
132-
and `%(alternative)s` may be used in the deprecation message
133-
to insert the name of an alternative to the deprecated
134-
object.
128+
Override the default deprecation message. The ``%(since)s``,
129+
``%(name)s``, ``%(alternative)s``, ``%(obj_type)s``, ``%(addendum)s``,
130+
and ``%(removal)s`` format specifiers will be replaced by the values
131+
of the respective arguments passed to this function.
135132
136133
name : str, optional
137134
The name used in the deprecation message; if not provided, the name

‎lib/matplotlib/colors.py

Copy file name to clipboardExpand all lines: lib/matplotlib/colors.py
+4-4Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,7 @@ def _create_lookup_table(N, data, gamma=1.0):
441441
442442
Notes
443443
-----
444-
This function is internally used for `.LinearSegmentedColormaps`.
444+
This function is internally used for `.LinearSegmentedColormap`.
445445
"""
446446

447447
if callable(data):
@@ -2024,9 +2024,9 @@ def from_levels_and_colors(levels, colors, extend='neither'):
20242024
The quantization levels used to construct the :class:`BoundaryNorm`.
20252025
Value ``v`` is quantized to level ``i`` if ``lev[i] <= v < lev[i+1]``.
20262026
colors : sequence of colors
2027-
The fill color to use for each level. If `extend` is "neither" there
2028-
must be ``n_level - 1`` colors. For an `extend` of "min" or "max" add
2029-
one extra color, and for an `extend` of "both" add two colors.
2027+
The fill color to use for each level. If *extend* is "neither" there
2028+
must be ``n_level - 1`` colors. For an *extend* of "min" or "max" add
2029+
one extra color, and for an *extend* of "both" add two colors.
20302030
extend : {'neither', 'min', 'max', 'both'}, optional
20312031
The behaviour when a value falls out of range of the given levels.
20322032
See :func:`~matplotlib.pyplot.contourf` for details.

‎lib/matplotlib/dates.py

Copy file name to clipboardExpand all lines: lib/matplotlib/dates.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -647,7 +647,7 @@ class ConciseDateFormatter(ticker.Formatter):
647647
formats : list of 6 strings, optional
648648
Format strings for 6 levels of tick labelling: mostly years,
649649
months, days, hours, minutes, and seconds. Strings use
650-
the same format codes as `strftime`. Default is
650+
the same format codes as `~datetime.datetime.strftime`. Default is
651651
``['%Y', '%b', '%d', '%H:%M', '%H:%M', '%S.%f']``
652652
653653
zero_formats : list of 6 strings, optional

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.