Skip to content

Commit 1d8b6fb

Browse files
efiringefiring
committed
Merge pull request #427 from WeatherGod/docfix/v1.1.0-polish
Final documentation polish for v1.1.0 release
2 parents fa483d7 + 44e36cb commit 1d8b6fb

File tree

11 files changed

+243
-29
lines changed

11 files changed

+243
-29
lines changed

‎doc/api/animation_api.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*********
2+
animation
3+
*********
4+
5+
6+
:mod:`matplotlib.animation`
7+
===========================
8+
9+
.. automodule:: matplotlib.animation
10+
:members:
11+
:undoc-members:
12+
:show-inheritance:

‎doc/api/api_changes.rst

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,34 @@ API Changes
55

66
This chapter is a log of changes to matplotlib that affect the
77
outward-facing API. If updating matplotlib breaks your scripts, this
8-
list may help describe what changes may be necessary in your code.
8+
list may help describe what changes may be necessary in your code or
9+
help figure out possible sources of the changes you are experiencing.
10+
11+
For new features that were added to matplotlib, please see
12+
:ref:`whats-new`.
13+
14+
Changes in 1.1.x
15+
================
16+
17+
* In :meth:`~matplotlib.pyplot.imshow`, setting *interpolation* to 'nearest'
18+
will now always mean that the nearest-neighbor interpolation is performed.
19+
If you want the no-op interpolation to be performed, choose 'none'.
20+
21+
* There were errors in how the tri-functions were handling input parameters
22+
that had to be fixed. If your tri-plots are not working correctly anymore,
23+
or you were working around apparent mistakes, please see issue #203 in the
24+
github tracker. When in doubt, use kwargs.
25+
26+
* The 'symlog' scale had some bad behavior in previous versions. This has now
27+
been fixed and users should now be able to use it without frustrations.
28+
The fixes did result in some minor changes in appearance for some users who
29+
may have been depending on the bad behavior.
30+
31+
* There is now a common set of markers for all plotting functions. Previously,
32+
some markers existed only for :meth:`~matplotlib.pyplot.scatter` or just for
33+
:meth:`~matplotlib.pyplot.plot`. This is now no longer the case. This merge
34+
did result in a conflict. The string 'd' now means "thin diamond" while
35+
'D' will mean "regular diamond".
936

1037
Changes beyond 0.99.x
1138
=====================
@@ -50,7 +77,7 @@ Changes beyond 0.99.x
5077
* The :meth:`matplotlib.axes.Axes.hist` *color* kwarg now accepts
5178
a sequence of color specs to match a sequence of datasets.
5279

53-
* The :class:'~matplotlib.collections.EllipseCollection' has been
80+
* The :class:`~matplotlib.collections.EllipseCollection` has been
5481
changed in two ways:
5582

5683
+ There is a new *units* option, 'xy', that scales the ellipse with

‎doc/api/index.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,11 @@
1515
api_changes.rst
1616
matplotlib_configuration_api.rst
1717
afm_api.rst
18+
animation_api.rst
1819
artist_api.rst
1920
axes_api.rst
2021
axis_api.rst
22+
index_backend_api.rst
2123
cbook_api.rst
2224
cm_api.rst
2325
collections_api.rst
@@ -27,13 +29,14 @@
2729
figure_api.rst
2830
font_manager_api.rst
2931
gridspec_api.rst
32+
legend_api.rst
3033
mathtext_api.rst
3134
mlab_api.rst
35+
nxutils_api.rst
3236
path_api.rst
3337
pyplot_api.rst
34-
nxutils_api.rst
3538
spines_api.rst
3639
ticker_api.rst
40+
tight_layout_api.rst
3741
units_api.rst
38-
index_backend_api.rst
3942
widgets_api.rst

‎doc/api/legend_api.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
******
2+
legend
3+
******
4+
5+
6+
:mod:`matplotlib.legend`
7+
=========================
8+
9+
.. automodule:: matplotlib.legend
10+
:members:
11+
:undoc-members:
12+
:show-inheritance:

‎doc/api/tight_layout_api.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
************
2+
tight_layout
3+
************
4+
5+
6+
:mod:`matplotlib.tight_layout`
7+
==============================
8+
9+
.. automodule:: matplotlib.tight_layout
10+
:members:
11+
:undoc-members:
12+
:show-inheritance:

‎doc/mpl_toolkits/mplot3d/api.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ mplot3d API
1919

2020
.. automodule:: mpl_toolkits.mplot3d.axes3d
2121
:members:
22+
:undoc-members:
2223
:show-inheritance:
2324

2425

@@ -38,6 +39,7 @@ mplot3d API
3839

3940
.. automodule:: mpl_toolkits.mplot3d.axis3d
4041
:members:
42+
:undoc-members:
4143
:show-inheritance:
4244

4345
.. _toolkit_mplot3d-artapi:
@@ -47,6 +49,7 @@ mplot3d API
4749

4850
.. automodule:: mpl_toolkits.mplot3d.art3d
4951
:members:
52+
:undoc-members:
5053
:show-inheritance:
5154

5255
.. _toolkit_mplot3d-projapi:
@@ -56,5 +59,6 @@ mplot3d API
5659

5760
.. automodule:: mpl_toolkits.mplot3d.proj3d
5861
:members:
62+
:undoc-members:
5963
:show-inheritance:
6064

‎doc/users/legend_guide.rst

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
Legend guide
55
************
66

7-
Do not proceed unless you already have read :func:`~matplotlib.pyplot.legend` and
8-
:class:`matplotlib.legend.Legend`!
7+
Do not proceed unless you already have read :func:`~matplotlib.pyplot.legend`
8+
and :class:`matplotlib.legend.Legend`!
99

1010

1111
What to be displayed
@@ -30,7 +30,7 @@ returns a tuple of two lists, i.e., list of artists and list of labels
3030
(python string). However, it does not return all of its child
3131
artists. It returns artists that are currently supported by matplotlib.
3232

33-
For matplotlib v1.0 and before, the supported artists are as follows.
33+
For matplotlib v1.0 and earlier, the supported artists are as follows.
3434

3535
* :class:`~matplotlib.lines.Line2D`
3636
* :class:`~matplotlib.patches.Patch`
@@ -186,11 +186,12 @@ legend.
186186
.. plot:: users/plotting/examples/simple_legend02.py
187187
:include-source:
188188

189+
.. _legend-complex-plots:
189190

190191
Legend of Complex Plots
191192
=======================
192193

193-
In matplotlib v1.1 (FIXME when released) and later, the legend is
194+
In matplotlib v1.1 and later, the legend is
194195
improved to support more plot commands and ease the customization.
195196

196197
Artist Container
@@ -224,15 +225,15 @@ or ::
224225
legend([b1], ["Bar 1"])
225226

226227

227-
At this time of writing, however, "bar" and "errorbar" are only
228+
At this time of writing, however, only "bar", "errorbar", and "stem" are
228229
supported (hopefully the list will increase). Here is an example.
229230

230231
.. plot:: mpl_examples/pylab_examples/legend_demo4.py
231232

232233
Legend Handler
233234
--------------
234235

235-
One of the change is that drawing of legend handles is delegated to
236+
One of the changes is that drawing of legend handles has been delegated to
236237
legend handlers. For example, :class:`~matplotlib.lines.Line2D`
237238
instances are handled by
238239
:class:`~matplotlib.legend_handler.HandlerLine2D`. The mapping
@@ -247,8 +248,9 @@ Let's consider the following sample code, ::
247248

248249
For each *p_i*, matplotlib
249250

250-
1. check if *p_i* itself is in the handler_map
251-
2. if not, iterate over type(p_i).mro() until a matching key is found in the handler_map
251+
1. check if *p_i* is in the handler_map
252+
2. if not, iterate over type(p_i).mro() until a matching key is found
253+
in the handler_map
252254

253255

254256
Unless specified, the defaul handler_map is used. Below is a partial
@@ -260,7 +262,7 @@ list of key-handler pairs included in the default handler map.
260262
* ...
261263

262264

263-
The legend command takes an optional argument of "handler_map". When
265+
The legend() command takes an optional argument of "handler_map". When
264266
provided, the default handler map will be updated (using dict.update
265267
method) with the provided one. ::
266268

@@ -279,9 +281,9 @@ instances (p1 and p2). ::
279281
In the above example, only *p1* will be handled by *my_handler*, while
280282
others will be handled by default handlers.
281283

282-
The curent default handler_map has handlers for errobar and bar
284+
The curent default handler_map has handlers for errorbar and bar
283285
plots. Also, it includes an entry for `tuple` which is mapped to
284-
`HandlerTuple`. It simply overplots all the handles for items in the
286+
`HandlerTuple`. It simply plots over all the handles for items in the
285287
given tuple. For example,
286288

287289

@@ -312,5 +314,5 @@ pixles, and *handlebox* is a OffsetBox instance. Within the call, you
312314
create relevant artists (using relevant properties from the *legend*
313315
and/or *orig_handle*) and add them into the handlebox. The artists
314316
needs to be scaled according to the fontsize (note that the size is in
315-
pixel, i.e., this is dpi-scaled value). See legend_handler.py for more
316-
details.
317+
pixel, i.e., this is dpi-scaled value). See :mod:`~matplotlib.legend_handler`
318+
for more details.

‎doc/users/whats_new.rst

Lines changed: 141 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,144 @@ What's new in matplotlib
77
This page just covers the highlights -- for the full story, see the
88
`CHANGELOG <http://matplotlib.sourceforge.net/_static/CHANGELOG>`_
99

10+
11+
.. _whats-new-1-1:
12+
13+
new in matplotlib-1.1
14+
=====================
15+
16+
Animation
17+
---------
18+
19+
Ryan May invested significant effort to create a backend-independent
20+
framework for creating animated figures. The :mod:`~matplotlib.animation`
21+
module is intended to replace the difficult-to-understand,
22+
backend-specific examples that used to exist in the :ref:`examples-index`
23+
listings.
24+
25+
This framework should be considered a beta feature for matplotlib, but
26+
we highly encourage users to try it out and provide feedback.
27+
28+
Check out the :ref:`animation-examples-index` and try them out!
29+
30+
31+
Tight Layout
32+
------------
33+
34+
A frequent issue raised by users of matplotlib is the lack of a layout
35+
engine to nicely space out elements of the plots. While matplotlib still
36+
adheres to the philosphy of giving users complete control over the placement
37+
of plot elements, Jae-Joon Lee created the :mod:`~matplotlib.tight_layout`
38+
module to address the most common layout issues.
39+
40+
:mod:`~matplotlib.tight_layout` will adjust the spacing between subplots
41+
so that the axis labels do not overlap with neighboring subplots. A
42+
:ref:`plotting-guide-tight-layout` has been created to show how to use
43+
this new tool.
44+
45+
Full IPython 0.11 compatibility
46+
-------------------------------
47+
48+
The `IPython <http://ipython.org>`_ team has recently released v0.11 of
49+
their interactive python shell. The matplotlib and IPython teams worked
50+
to ensure that our packages work well together. This release of matplotlib
51+
is fully compatible with ipython.
52+
53+
Legend
54+
------
55+
56+
Jae-Joon Lee has also been working on revamping how plot legends are handled
57+
in matplotlib. This has resulted in some immediate enhancements. First,
58+
legends for complex plots such as :meth:`~matplotlib.pyplot.stem` plots
59+
will now display correctly. Second, the 'best' placement of a legend has
60+
been improved in the presence of NANs.
61+
62+
See :ref:`legend-complex-plots` for more detailed explanation and
63+
examples.
64+
65+
.. plot:: mpl_examples/pylab_examples/legend_demo4.py
66+
67+
mplot3d
68+
-------
69+
70+
In continuing the efforts to make 3D plotting in matplotlib just as easy
71+
as 2D plotting, Ben Root has made several improvements to the
72+
:mod:`~mpl_toolkits.mplot3d` module.
73+
74+
* :class:`~mpl_toolkits.mplot3d.axes3d.Axes3D` has been
75+
improved to bring the class towards feature-parity with regular
76+
Axes objects
77+
78+
* Documentation for :ref:`toolkit_mplot3d-index` was significantly expanded
79+
80+
* Axis labels and orientation improved
81+
82+
* Most 3D plotting functions now support empty inputs
83+
84+
* Ticker offset display added:
85+
.. plot:: mpl_examples/mplot3d/offset_demo.py
86+
87+
* :meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.contourf`
88+
gains *zdir* and *offset* kwargs. You can now do this:
89+
.. plot:: mpl_examples/mplot3d/contourf3d_demo2.py
90+
91+
Numerix support removed
92+
-----------------------
93+
94+
After more than two years of deprecation warnings, Numerix support has
95+
now been completely removed from matplotlib.
96+
97+
Markers
98+
-------
99+
100+
The list of available markers for :meth:`~matplotlib.pyplot.plot` and
101+
:meth:`~matplotlib.pyplot.scatter` has now been merged. While they
102+
were mostly similar, some markers existed for one function, but not
103+
the other. This merge did result in a conflict for the 'd' diamond
104+
marker. Now, 'd' will be interpreated to always mean "thin" diamond
105+
while 'D' will mean "regular" diamond.
106+
107+
Thanks to Michael Droettboom for this effort.
108+
109+
Other improvements
110+
------------------
111+
112+
* Unit support for polar axes and :func:`~matplotlib.axes.Axes.arrow`
113+
114+
* :class:`~matplotlib.projections.polar.PolarAxes` gains getters and setters for
115+
"theta_direction", and "theta_offset" to allow for theta to go in
116+
either the clock-wise or counter-clockwise direction and to specify where zero
117+
degrees should be placed.
118+
:meth:`~matplotlib.projections.polar.PolarAxes.set_theta_zero_location` is an
119+
added convenience function.
120+
121+
* Fixed error in argument handling for tri-functions such as
122+
:meth:`~matplotlib.pyplot.tripcolor`
123+
124+
* ``axes.labelweight`` parameter added to rcParams.
125+
126+
* For :meth:`~matplotlib.pyplot.imshow`, *interpolation='nearest'* will
127+
now always perform an interpolation. A "none" option has been added to
128+
indicate no interpolation at all.
129+
130+
* An error in the Hammer projection has been fixed.
131+
132+
* *clabel* for :meth:`~matplotlib.pyplot.contour` now accepts a callable.
133+
Thanks to Daniel Hyams for the original patch!
134+
135+
* Jae-Joon Lee added the :class:`~mpl_toolkits.axes_grid1.axes_divider.HBox`
136+
and :class:`~mpl_toolkits.axes_grid1.axes_divider.VBox` classes.
137+
138+
* Christoph Gohike improved memory usage in :meth:`~matplotlib.pyplot.imshow`.
139+
140+
* :meth:`~matplotlib.pyplot.scatter` now accepts empty inputs.
141+
142+
* The behavior for 'symlog' scale has been fixed, but this may result
143+
in some minor changes to existing plots.
144+
145+
146+
.. _whats-new-1-0:
147+
10148
new in matplotlib-1.0
11149
======================
12150

@@ -53,7 +191,7 @@ talented developers for years. :func:`~matplotlib.pyplot.contourf`
53191
now handles interior masked regions, and the boundaries of line and
54192
filled contours coincide.
55193

56-
Additionally, he has contributed a new module `matplotlib.tri` and
194+
Additionally, he has contributed a new module :mod:`~matplotlib.tri` and
57195
helper function :func:`~matplotlib.pyplot.triplot` for creating and
58196
plotting unstructured triangular grids.
59197

@@ -139,6 +277,8 @@ help from Jae-Joon Lee, Michael Droettboom, Christoph Gohlke and
139277
Michiel de Hoon.
140278

141279

280+
.. _whats-new-0-99:
281+
142282
new in matplotlib-0.99
143283
======================
144284

0 commit comments

Comments
 (0)