8000 Merge pull request #15067 from QuLogic/fix-xref-whats-new-1 · matplotlib/matplotlib@0be1098 · GitHub
[go: up one dir, main page]
Skip to content

Commit 0be1098

Browse files
timhoffmtimhoffm
authored
Merge pull request #15067 from QuLogic/fix-xref-whats-new-1
Fix cross-references in API changes < 1.0
2 parents 0b797a1 + a37c20a commit 0be1098

10 files changed

+206
-565
lines changed

‎doc/api/prev_api_changes/api_changes_0.91.0.rst

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,19 @@
22
Changes for 0.91.0
33
==================
44

5-
* Changed :func:`cbook.is_file_like` to
6-
:func:`cbook.is_writable_file_like` and corrected behavior.
5+
* Changed ``cbook.is_file_like`` to ``cbook.is_writable_file_like`` and
6+
corrected behavior.
77

8-
* Added ax kwarg to :func:`pyplot.colorbar` and
9-
:meth:`Figure.colorbar` so that one can specify the axes object from
8+
* Added *ax* keyword argument to :func:`.pyplot.colorbar` and
9+
:meth:`.Figure.colorbar` so that one can specify the axes object from
1010
which space for the colorbar is to be taken, if one does not want to
1111
make the colorbar axes manually.
1212

13-
* Changed :func:`cbook.reversed` so it yields a tuple rather than a
14-
(index, tuple). This agrees with the python reversed builtin,
15-
and cbook only defines reversed if python doesn't provide the
16-
builtin.
13+
* Changed ``cbook.reversed`` so it yields a tuple rather than a (index, tuple).
14+
This agrees with the Python reversed builtin, and cbook only defines reversed
15+
if Python doesn't provide the builtin.
1716

18-
* Made skiprows=1 the default on :func:`csv2rec`
17+
* Made skiprows=1 the default on ``csv2rec``
1918

2019
* The gd and paint backends have been deleted.
2120

@@ -32,17 +31,18 @@ Changes for 0.91.0
3231
files. In the future the class might actually parse the font to
3332
allow e.g., subsetting.
3433

35-
* :mod:`matplotlib.FT2Font` now supports :meth:`FT_Attach_File`. In
34+
* :mod:`matplotlib.ft2font` now supports ``FT_Attach_File``. In
3635
practice this can be used to read an afm file in addition to a
3736
pfa/pfb file, to get metrics and kerning information for a Type 1
3837
font.
3938

40-
* The :class:`AFM` class now supports querying CapHeight and stem
39+
* The :class:`.AFM` class now supports querying CapHeight and stem
4140
widths. The get_name_char method now has an isord kwarg like
4241
get_width_char.
4342

44-
* Changed :func:`pcolor` default to shading='flat'; but as noted now in the
45-
docstring, it is preferable to simply use the edgecolor kwarg.
43+
* Changed :func:`.pcolor` default to ``shading='flat'``; but as noted now in
44+
the docstring, it is preferable to simply use the *edgecolor* keyword
45+
argument.
4646

4747
* The mathtext font commands (``\cal``, ``\rm``, ``\it``, ``\tt``) now
4848
behave as TeX does: they are in effect until the next font change
@@ -57,8 +57,7 @@ Changes for 0.91.0
5757
extent of a line of ordinary text. The default is 1.2;
5858
``linespacing=2`` would be like ordinary double spacing, for example.
5959

60-
* Changed default kwarg in
61-
:meth:`matplotlib.colors.Normalize.__init__`` to ``clip=False``;
60+
* Changed default kwarg in `matplotlib.colors.Normalize` to ``clip=False``;
6261
clipping silently defeats the purpose of the special over, under,
6362
and bad values in the colormap, thereby leading to unexpected
6463
behavior. The new default should reduce such surprises.

‎doc/api/prev_api_changes/api_changes_0.91.2.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
Changes for 0.91.2
33
==================
44

5-
* For :func:`csv2rec`, checkrows=0 is the new default indicating all rows
5+
* For ``csv2rec``, checkrows=0 is the new default indicating all rows
66
will be checked for type inference
77

88
* A warning is issued when an image is drawn on log-scaled axes, since
99
it will not log-scale the image data.
1010

11-
* Moved :func:`rec2gtk` to :mod:`matplotlib.toolkits.gtktools`
11+
* Moved ``rec2gtk`` to ``matplotlib.toolkits.gtktools``
1212

13-
* Moved :func:`rec2excel` to :mod:`matplotlib.toolkits.exceltools`
13+
* Moved ``rec2excel`` to ``matplotlib.toolkits.exceltools``
1414

1515
* Removed, dead/experimental ExampleInfo, Namespace and Importer
16-
code from :mod:`matplotlib.__init__`
16+
code from :mod:`matplotlib`

‎doc/api/prev_api_changes/api_changes_0.98.0.rst

Lines changed: 154 additions & 141 deletions
Large diffs are not rendered by default.

‎doc/api/prev_api_changes/api_changes_0.98.1.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Changes for 0.98.1
22
==================
33

4-
* Removed broken :mod:`matplotlib.axes3d` support and replaced it with
5-
a non-implemented error pointing to 0.91.x
4+
* Removed broken ``matplotlib.axes3d`` support and replaced it with a
5+
non-implemented error pointing to 0.91.x

‎doc/api/prev_api_changes/api_changes_0.98.x.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11

22
Changes for 0.98.x
33
==================
4-
* psd(), csd(), and cohere() will now automatically wrap negative
4+
* ``psd()``, ``csd()``, and ``cohere()`` will now automatically wrap negative
55
frequency components to the beginning of the returned arrays.
66
This is much more sensible behavior and makes them consistent
7-
with specgram(). The previous behavior was more of an oversight
7+
with ``specgram()``. The previous behavior was more of an oversight
88
than a design decision.
99

1010
* Added new keyword parameters *nonposx*, *nonposy* to
@@ -15,7 +15,7 @@ Changes for 0.98.x
1515

1616
* Added new :func:`matplotlib.pyplot.fignum_exists` and
1717
:func:`matplotlib.pyplot.get_fignums`; they merely expose
18-
information that had been hidden in :mod:`matplotlib._pylab_helpers`.
18+
information that had been hidden in ``matplotlib._pylab_helpers``.
1919

2020
* Deprecated numerix package.
2121

@@ -28,7 +28,7 @@ Changes for 0.98.x
2828
* Changed the defaults of acorr and xcorr to use usevlines=True,
2929
maxlags=10 and normed=True since these are the best defaults
3030

31-
* Following keyword parameters for :class:`matplotlib.label.Label` are now
31+
* Following keyword parameters for :class:`matplotlib.legend.Legend` are now
3232
deprecated and new set of parameters are introduced. The new parameters
3333
are given as a fraction of the font-size. Also, *scatteryoffsets*,
3434
*fancybox* and *columnspacing* are added as keyword parameters.
@@ -61,7 +61,7 @@ Changes for 0.98.x
6161

6262
* :meth:`matplotlib.axes.Axes.set_xlim`,
6363
:meth:`matplotlib.axes.Axes.set_ylim` now return a copy of the
64-
:attr:`viewlim` array to avoid modify-in-place surprises.
64+
``viewlim`` array to avoid modify-in-place surprises.
6565

6666
* :meth:`matplotlib.afm.AFM.get_fullname` and
6767
:meth:`matplotlib.afm.AFM.get_familyname` no longer raise an
@@ -86,13 +86,13 @@ Changes for 0.98.x
8686
:meth:`matplotlib.collections.Collection.set_offsets` added to
8787
:class:`~matplotlib.collections.Collection` base class.
8888

89-
* :attr:`matplotlib.figure.Figure.figurePatch` renamed
89+
* ``matplotlib.figure.Figure.figurePatch`` renamed
9090
:attr:`matplotlib.figure.Figure.patch`;
91-
:attr:`matplotlib.axes.Axes.axesPatch` renamed
91+
``matplotlib.axes.Axes.axesPatch`` renamed
9292
:attr:`matplotlib.axes.Axes.patch`;
93-
:attr:`matplotlib.axes.Axes.axesFrame` renamed
93+
``matplotlib.axes.Axes.axesFrame`` renamed
9494
:attr:`matplotlib.axes.Axes.frame`.
95-
:meth:`matplotlib.axes.Axes.get_frame`, which returns
95+
``matplotlib.axes.Axes.get_frame``, which returns
9696
:attr:`matplotlib.axes.Axes.patch`, is deprecated.
9797

9898
* Changes in the :class:`matplotlib.contour.ContourLabeler` attributes
@@ -105,6 +105,6 @@ Changes for 0.98.x
105105

106106
* Moved several functions in :mod:`matplotlib.mlab` and
107107
:mod:`matplotlib.cbook` into a separate module
108-
:mod:`matplotlib.numerical_methods` because they were unrelated to
108+
``matplotlib.numerical_methods`` because they were unrelated to
109109
the initial purpose of mlab or cbook and appeared more coherent
110110
elsewhere.

‎doc/api/prev_api_changes/api_changes_0.99.x.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Changes beyond 0.99.x
5656

5757
* There is a new rc parameter ``axes.color_cycle``, and the color
5858
cycle is now independent of the rc parameter ``lines.color``.
59-
:func:`matplotlib.Axes.set_default_color_cycle` is deprecated.
59+
``matplotlib.Axes.set_default_color_cycle`` is deprecated.
6060

6161
* You can now print several figures to one pdf file and modify the
6262
document information dictionary of a pdf file. See the docstrings

‎doc/api/prev_api_changes/api_changes_1.4.x.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ original location:
4646
the upper and lower limits (*lolims*, *uplims*, *xlolims*, *xuplims*) now
4747
point in the correct direction.
4848

49-
* The *fmt* kwarg for :func:`~matplotlib.pyplot.errorbar now supports
49+
* The *fmt* kwarg for :func:`~matplotlib.pyplot.errorbar` now supports
5050
the string 'none' to suppress drawing of a line and markers; use
5151
of the *None* object for this is deprecated. The default *fmt*
5252
value is changed to the empty string (''), so the line and markers
@@ -72,7 +72,7 @@ original location:
7272
* For consistency the ``face_alpha`` keyword to
7373
:class:`matplotlib.patheffects.SimplePatchShadow` has been deprecated in
7474
favour of the ``alpha`` keyword. Similarly, the keyword ``offset_xy`` is now
75-
named ``offset`` across all :class:`~matplotlib.patheffects.AbstractPathEffect`s.
75+
named ``offset`` across all :class:`~matplotlib.patheffects.AbstractPathEffect`\ s.
7676
``matplotlib.patheffects._Base`` has
7777
been renamed to :class:`matplotlib.patheffects.AbstractPathEffect`.
7878
``matplotlib.patheffect.ProxyRenderer`` has been renamed to

‎doc/api/prev_api_changes/api_changes_3.1.0.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -865,8 +865,8 @@ future version.
865865

866866
- `.projections.process_projection_requirements`
867867

868-
- `.backend_ps.PsBackendHelper``
869-
- `.backend_ps.ps_backend_helper``,
868+
- ``backend_ps.PsBackendHelper``
869+
- ``backend_ps.ps_backend_helper``,
870870

871871
- `.cbook.iterable`
872872
- `.cbook.get_label`
@@ -938,7 +938,8 @@ Axes3D
938938
- `.axes3d.Axes3D.w_yaxis`
939939
- `.axes3d.Axes3D.w_zaxis`
940940

941-
Use `.axes3d.Axes3D.xaxis`, `.axes3d.Axes3D.and `.axes3d.Axes3D.zaxis` instead.
941+
Use `.axes3d.Axes3D.xaxis`, `.axes3d.Axes3D.yaxis` and `.axes3d.Axes3D.zaxis`
942+
instead.
942943

943944
Testing
944945
~~~~~~~
@@ -960,8 +961,8 @@ whereas calling ``set_facecolor`` does.
960961
GUI / backend details
961962
~~~~~~~~~~~~~~~~~~~~~
962963

963-
- `.get_py2exe_datafiles``
964-
- `.tk_window_focus``
964+
- ``.get_py2exe_datafiles``
965+
- ``.tk_window_focus``
965966
- `.backend_gtk3.FileChooserDialog`
966967
- `.backend_gtk3.NavigationToolbar2GTK3.get_filechooser`
967968
- `.backend_gtk3.SaveFigureGTK3.get_filechooser`

0 commit comments

Comments
 (0)
0