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

Skip to content

Commit d2d3626

Browse files
committed
DOC: Add links all across what's new page.
1 parent 2b789a2 commit d2d3626

File tree

1 file changed

+69
-55
lines changed

1 file changed

+69
-55
lines changed

doc/users/whats_new.rst

Lines changed: 69 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ Jake Vanderplas' JSAnimation package has been merged into matplotlib. This
7777
adds to matplotlib the `~matplotlib.animation.HTMLWriter` class for
7878
generating a javascript HTML animation, suitable for the IPython notebook.
7979
This can be activated by default by setting the ``animation.html`` rc
80-
parameter to ``jshtml``. One can also call the ``anim_to_jshtml`` function
81-
to manually convert an animation. This can be displayed using IPython's
82-
``HTML`` display class::
80+
parameter to ``jshtml``. One can also call the
81+
`~matplotlib.animation.Animation.to_jshtml` method to manually convert an
82+
animation. This can be displayed using IPython's ``HTML`` display class::
8383

8484
from IPython.display import HTML
8585
HTML(animation.anim_to_jshtml(anim))
@@ -107,7 +107,10 @@ path.
107107
CheckButtons widget get_status function
108108
---------------------------------------
109109

110-
A :func:`get_status` function has been added the :class:`matplotlib.widgets.CheckButtons` class. This :func:`get_status` function allows user to query the status (True/False) of all of the buttons in the CheckButtons object.
110+
A :func:`~matplotlib.widgets.CheckButtons.get_status` method has been added the
111+
:class:`matplotlib.widgets.CheckButtons` class. This ``get_status`` method
112+
allows user to query the status (True/False) of all of the buttons in the
113+
``CheckButtons`` object.
111114

112115

113116
Abstract base class for movie writers
@@ -123,7 +126,7 @@ from the new abstract base class.
123126
Add fill_bar argument to ``AnchoredSizeBar``
124127
--------------------------------------------
125128

126-
The mpl_toolkits class
129+
The ``mpl_toolkits`` class
127130
:class:`~mpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar` now has an
128131
additional ``fill_bar`` argument, which makes the size bar a solid rectangle
129132
instead of just drawing the border of the rectangle. The default is ``None``,
@@ -138,7 +141,7 @@ rectangle for the size bar.
138141
Annotation can use a default arrow style
139142
----------------------------------------
140143

141-
Annotations now use the default arrow style when setting `arrowprops={}`,
144+
Annotations now use the default arrow style when setting ``arrowprops={}``,
142145
rather than no arrow (the new behavior actually matches the documentation).
143146

144147

@@ -149,33 +152,36 @@ Orthographic projection for mplot3d
149152

150153
``voxels`` function for mplot3d
151154
-------------------------------
152-
:class:`~mpl_toolkits.mplot3d.axes3d.Axes3D` now has a ``voxels`` method, for
153-
visualizing boolean 3d data. Uses could include plotting a sparse 3D heat map,
154-
or visualizing a volumetric model.
155+
:class:`~mpl_toolkits.mplot3d.axes3d.Axes3D` now has a
156+
`~mpl_toolkits.mplot3d.axes3d.Axes3D.voxels` method, for visualizing boolean 3d
157+
data. Uses could include plotting a sparse 3D heat map, or visualizing a
158+
volumetric model.
155159

156160

157161
Barbs and Quiver Support Dates
158162
------------------------------
159163

160-
When using the :func:`quiver` and :func:`barbs` plotting methods,
161-
it is now possible to pass dates, just like for other methods like
162-
:func:`plot`. This also allows these functions to handle values
163-
that need unit-conversion applied.
164+
When using the :func:`~matplotlib.axes.Axes.quiver` and
165+
:func:`~matplotlib.axes.Axes.barbs` plotting methods, it is now possible to
166+
pass dates, just like for other methods like :func:`~matplotlib.axes.Axes.plot`.
167+
This also allows these functions to handle values that need unit-conversion
168+
applied.
164169

165170

166171
Hexbin default line color
167172
-------------------------
168173

169-
The default ``linecolor`` kwarg for :func:`hexbin` is now ``'face'``, and
170-
supplying ``'none'`` now prevents lines from being drawn around the hexagons.
174+
The default ``linecolor`` kwarg for :func:`~matplotlib.axes.Axes.hexbin` is now
175+
``'face'``, and supplying ``'none'`` now prevents lines from being drawn around
176+
the hexagons.
171177

172178

173-
figure.legend() can be called without arguments
179+
Figure.legend() can be called without arguments
174180
-----------------------------------------------
175181

176-
Calling :func:`figure.legend` can now be done with no arguments. In this case a
177-
legend will be created that contains all the artists on all the axes contained
178-
within the figure.
182+
Calling ``Figure.``:func:`~matplotlib.figure.Figure.legend` can now be
183+
done with no arguments. In this case a legend will be created that contains all
184+
the artists on all the axes contained within the figure.
179185

180186

181187
New parameter `clear` for :func:`~matplotlib.pyplot.figure`
@@ -213,22 +219,23 @@ from :func:`~matplotlib.pyplot.figure`, it can also be used there::
213219

214220
AVConv writer is back
215221
---------------------
216-
Correct a bug that prevented detection of AVconv for matplotlib.animation.
222+
Correct a bug that prevented detection of AVconv for `matplotlib.animation`.
217223

218224

219225
Invalid (Non-finite) Axis Limit Error
220226
-------------------------------------
221227

222-
When using :func:`set_xlim` and :func:`set_ylim`, passing non-finite values now
223-
results in a ValueError. The previous behavior resulted in the limits being
224-
erroneously reset to `(-0.001, 0.001)`.
228+
When using :func:`~matplotlib.axes.Axes.set_xlim` and
229+
:func:`~matplotlib.axes.Axes.set_ylim`, passing non-finite values now results
230+
in a ``ValueError``. The previous behavior resulted in the limits being
231+
erroneously reset to ``(-0.001, 0.001)``.
225232

226233

227234
Metadata savefig kwarg
228235
----------------------
229236

230-
:func:`~matplotlib.pyplot.savefig` now accepts `metadata` as a keyword argument.
231-
It can be used to store key/value pairs in the image metadata.
237+
:func:`~matplotlib.pyplot.savefig` now accepts ``metadata`` as a keyword
238+
argument. It can be used to store key/value pairs in the image metadata.
232239

233240
Supported formats and backends
234241
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -249,17 +256,17 @@ Example
249256
Specify minimum value to format as scalar for ``LogFormatterMathtext``
250257
----------------------------------------------------------------------
251258

252-
``LogFormatterMathtext`` now includes the option to specify a minimum value
253-
exponent to format as a scalar (ie. 0.001 instead of 10^-3).
259+
:class:`~matplotlib.ticker.LogFormatterMathtext` now includes the option to
260+
specify a minimum value exponent to format as a scalar (ie. 0.001 instead of 10^-3).
254261

255262

256263
Multiple legend keys for legend entries
257264
---------------------------------------
258265

259266
A legend entry can now contain more than one legend key. The extended
260-
``HandlerTuple`` class now accepts two parameters: ``ndivide`` divides the
261-
legend area in the specified number of sections; ``pad`` changes the padding
262-
between the legend keys.
267+
`~matplotlib.legend_handler.HandlerTuple` class now accepts two parameters:
268+
``ndivide`` divides the legend area in the specified number of sections;
269+
``pad`` changes the padding between the legend keys.
263270

264271
.. figure:: /gallery/text_labels_and_annotations/images/sphx_glr_legend_demo_004.png
265272
:target: ../gallery/text_labels_and_annotations/legend_demo.html
@@ -278,7 +285,7 @@ notice better rendering performance when plotting large amounts of
278285
data (as long as the above parameters are set accordingly). Only the
279286
line segment portion of paths will be simplified -- if you are also
280287
drawing markers and experiencing problems with rendering speed, you
281-
should consider using the ``markevery`` option to ``plot``.
288+
should consider using the ``markevery`` option to `~matplotlib.axes.Axes.plot`.
282289
See the :ref:`performance` section in the usage tutorial for more
283290
information.
284291

@@ -298,16 +305,17 @@ values are unlikely to cause any visible differences in your plots.
298305
Added `matplotlib.ticker.PercentFormatter`
299306
------------------------------------------
300307

301-
The new formatter has some nice features like being able to convert from
302-
arbitrary data scales to percents, a customizable percent symbol and
303-
either automatic or manual control over the decimal points.
308+
The new `~matplotlib.ticker.PercentFormatter` formatter has some nice features
309+
like being able to convert from arbitrary data scales to percents, a
310+
customizable percent symbol and either automatic or manual control over the
311+
decimal points.
304312

305313

306314
New quiverkey angle kwarg
307315
-------------------------
308316

309-
Plotting a :func:`quiverkey` now admits the ``angle`` kwarg,
310-
which sets the angle at which to draw the key arrow.
317+
Plotting a :func:`~matplotlib.axes.Axes.quiverkey` now admits the ``angle``
318+
kwarg, which sets the angle at which to draw the key arrow.
311319

312320

313321
Reproducible PS, PDF and SVG output
@@ -352,16 +360,18 @@ reversed.
352360
`Collection` offsets are no longer implicitly flattened
353361
-------------------------------------------------------
354362

355-
`Collection` (and thus `scatter` -- both 2D and 3D) no longer implicitly
356-
flattens its offsets. As a consequence, `scatter`'s x and y arguments can no
357-
longer be 2+-dimensional arrays.
363+
`~matplotlib.collections.Collection` (and thus both 2D
364+
`~matplotlib.axes.Axes.scatter` and 3D
365+
`~mpl_toolkits.mplot3d.axes3d.Axes3D.scatter`) no
366+
longer implicitly flattens its offsets. As a consequence, ``scatter``'s ``x``
367+
and ``y`` arguments can no longer be 2+-dimensional arrays.
358368

359369

360370
`Artist.setp` (and `pyplot.setp`) accept a `file` argument
361371
----------------------------------------------------------
362372

363373
The argument is keyword-only. It allows an output file other than
364-
`sys.stdout` to be specified. It works exactly like the `file` argument
374+
`sys.stdout` to be specified. It works exactly like the ``file`` argument
365375
to `print`.
366376

367377

@@ -376,7 +386,8 @@ visibility of the flow pattern in some use cases.
376386
`Axis.set_tick_params` now responds to 'rotation'
377387
-------------------------------------------------
378388

379-
Bulk setting of tick label rotation is now possible via :func:`set_tick_params` using the `rotation` keyword.
389+
Bulk setting of tick label rotation is now possible via
390+
:func:`~matplotlib.axis.Axis.set_tick_params` using the ``rotation`` keyword.
380391

381392
Example
382393
~~~~~~~
@@ -387,9 +398,10 @@ Example
387398
Users can now toggle shading in 3D bar plots
388399
--------------------------------------------
389400

390-
A new ``shade`` parameter has been added the 3D bar plotting method.
391-
The default behavior remains to shade the bars, but now users
392-
have the option of setting ``shade`` to ``False``.
401+
A new ``shade`` parameter has been added the 3D
402+
`~mpl_toolkits.mplot3d.axes3d.Axes3D.bar` plotting method. The default behavior
403+
remains to shade the bars, but now users have the option of setting ``shade``
404+
to ``False``.
393405

394406

395407
Example
@@ -417,10 +429,10 @@ Example
417429
New which Parameter for autofmt_xdate
418430
-------------------------------------
419431

420-
A ``which`` parameter now exists for the method :func:`autofmt_xdate`. This
421-
allows a user to format ``major``, ``minor`` or ``both`` tick labels
422-
selectively. If ``which`` is ``None`` (default) then the method will rotate
423-
``major`` tick labels.
432+
A ``which`` parameter now exists for the method
433+
:func:`~matplotlib.figure.Figure.autofmt_xdate`. This allows a user to format
434+
``major``, ``minor`` or ``both`` tick labels selectively. If ``which`` is
435+
``None`` (default) then the method will rotate ``major`` tick labels.
424436

425437
Example
426438
~~~~~~~
@@ -432,10 +444,11 @@ Example
432444
New Figure Parameter for subplot2grid
433445
-------------------------------------
434446

435-
A ``fig`` parameter now exists for the method :func:`subplot2grid`. This allows
436-
a user to specify the figure where the subplots will be created. If ``fig``
437-
is ``None`` (default) then the method will use the current figure retrieved by
438-
:func:`gcf`.
447+
A ``fig`` parameter now exists for the function
448+
:func:`~matplotlib.pyplot.subplot2grid`. This allows a user to specify the
449+
figure where the subplots will be created. If ``fig`` is ``None`` (default)
450+
then the method will use the current figure retrieved by
451+
:func:`~matplotlib.pyplot.gcf`.
439452

440453
Example
441454
~~~~~~~
@@ -447,9 +460,10 @@ Example
447460
Interpolation in fill_betweenx
448461
------------------------------
449462

450-
The ``interpolate`` parameter now exists for the method :func:`fill_betweenx`.
451-
This allows a user to interpolate the data and fill the areas in the crossover
452-
points, similarly to :func:`fill_between`.
463+
The ``interpolate`` parameter now exists for the method
464+
:func:`~matplotlib.axes.Axes.fill_betweenx`. This allows a user to interpolate
465+
the data and fill the areas in the crossover points, similarly to
466+
:func:`~matplotlib.axes.Axes.fill_between`.
453467

454468

455469
Validation of line style rcParams

0 commit comments

Comments
 (0)