10000 DOC: clean up API changes a bit · matplotlib/matplotlib@7652e40 · GitHub
[go: up one dir, main page]
Skip to content

Commit 7652e40

Browse files
tacaswelltacaswell
committed
DOC: clean up API changes a bit
1 parent ee0d3e2 commit 7652e40

File tree

1 file changed

+23
-23
lines changed
  • doc/api
    • < 10000 span class="PRIVATE_TreeView-item-content-text prc-TreeView-TreeViewItemContentText-smZM-">api_changes.rst

1 file changed

+23
-23
lines changed

‎doc/api/api_changes.rst

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,8 @@ For new features that were added to matplotlib, please see
1212
:ref:`whats-new`.
1313

1414

15-
Changes in 2.0.0
16-
================
17-
18-
15+
API Changes in 2.0.0
16+
====================
1917

2018
Deprecation and removal
2119
-----------------------
@@ -46,14 +44,11 @@ provides a better and more tested way of rendering figures to WX windows.
4644
CocoaAgg backend removed
4745
~~~~~~~~~~~~~~~~~~~~~~~~
4846

49-
The deprecated and not fully functional CocoaAgg backend has been removed
50-
47+
The deprecated and not fully functional CocoaAgg backend has been removed.
5148

52-
General
53-
-------
5449

5550
`Artist.update` has return value
56-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51+
--------------------------------
5752

5853
The methods `matplotlib.artist.Artist.set`,
5954
`matplotlib.Artist.update`, and the function `matplotlib.artist.setp`
@@ -74,7 +69,7 @@ properties.
7469

7570

7671
`Legend` initializers gain edgecolor and facecolor kwargs
77-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
72+
---------------------------------------------------------
7873

7974
The :class:`~matplotlib.legend.Legend` background patch (or 'frame')
8075
can have its `edgecolor` and `facecolor` determined by the
@@ -86,7 +81,7 @@ controls the alpha transparency of the patch.
8681

8782

8883
Qualitative colormaps
89-
~~~~~~~~~~~~~~~~~~~~~
84+
---------------------
9085

9186
Colorbrewer's qualitative/discrete colormaps ("Accent", "Dark2", "Paired",
9287
"Pastel1", "Pastel2", "Set1", "Set2", "Set3") are now implemented as
@@ -108,11 +103,9 @@ to transform images by returning ``True`` from ``option_scale_image``.
108103
See the ``draw_image`` docstring for more information.
109104

110105

111-
Tickers
112-
-------
113106

114-
``matplotlib.ticker.LinearLocator`` algorithm update
115-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
107+
`matplotlib.ticker.LinearLocator` algorithm update
108+
--------------------------------------------------
116109

117110
The ``matplotlib.ticker.LinearLocator`` is used to define the range and location
118111
of tickmarks of a plot when the user wants a exact number of ticks.
@@ -128,18 +121,25 @@ constistently. For example, when both y-axis of a``twinx`` plot use
128121
both axis will be properly aligned at convenient tick locations.
129122

130123

131-
MPlot3D
132-
-------
133-
134124
New defaults for 3D quiver function in mpl_toolkits.mplot3d.axes3d.py
135-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
136-
Matplotlib has both a 2D and a 3D ``quiver`` function. These changes affect only the 3D function and make the default behavior of the 3D function match 2D version. There are two changes:
125+
---------------------------------------------------------------------
126+
127+
Matplotlib has both a 2D and a 3D ``quiver`` function. These changes
128+
affect only the 3D function and make the default behavior of the 3D
129+
function match 2D version. There are two changes:
137130

138-
1) The 3D quiver function previously normalized the arrows to be the same length, which makes it unusable for situations where the arrows should be different lengths and does not match the behavior of the 2D function. This normalization behavior is now controlled with the ``normalize`` keyword, which defaults to False.
131+
1) The 3D quiver function previously normalized the arrows to be the
132+
same length, which makes it unusable for situations where the
133+
arrows should be different lengths and does not match the behavior
134+
of the 2D function. This normalization behavior is now controlled
135+
with the ``normalize`` keyword, which defaults to False.
139136

140-
2) The ``pivot`` keyword now defaults to ``tail`` instead of ``tip``. This was done in order to match the default behavior of the 2D quiver function.
137+
2) The ``pivot`` keyword now defaults to ``tail`` instead of
138+
``tip``. This was done in order to match the default behavior of
139+
the 2D quiver function.
141140

142-
To obtain the previous behavior with the 3D quiver function, one can call the function with ::
141+
To obtain the previous behavior with the 3D quiver function, one can
142+
call the function with ::
143143

144144
ax.quiver(x, y, z, u, v, w, normalize=True, pivot='tip')
145145

0 commit comments

Comments
 (0)
0