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

Skip to content

Commit e51c507

Browse files
committed
Replace kwarg jargon in recent what's new.
1 parent 4f65a8a commit e51c507

3 files changed

Lines changed: 32 additions & 33 deletions

File tree

doc/users/prev_whats_new/whats_new_3.0.rst

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -60,22 +60,21 @@ have a frame. Padding and separation parameters can be adjusted.
6060
Add ``minorticks_on()/off()`` methods for colorbar
6161
--------------------------------------------------
6262

63-
A new method :meth:`.colorbar.Colobar.minorticks_on` has been added
64-
to correctly display minor ticks on a colorbar. This method
65-
doesn't allow the minor ticks to extend into the regions beyond vmin and vmax
66-
when the *extend* kwarg (used while creating the colorbar) is set to 'both',
67-
'max' or 'min'.
68-
A complementary method :meth:`.colorbar.Colobar.minorticks_off`
69-
has also been added to remove the minor ticks on the colorbar.
63+
A new method :meth:`.colorbar.Colobar.minorticks_on` has been added to
64+
correctly display minor ticks on a colorbar. This method doesn't allow the
65+
minor ticks to extend into the regions beyond vmin and vmax when the *extend*
66+
keyword argument (used while creating the colorbar) is set to 'both', 'max' or
67+
'min'. A complementary method :meth:`.colorbar.Colobar.minorticks_off` has
68+
also been added to remove the minor ticks on the colorbar.
7069

7170

7271
Colorbar ticks can now be automatic
7372
-----------------------------------
7473

7574
The number of ticks placed on colorbars was previously appropriate for a large
76-
colorbar, but looked bad if the colorbar was made smaller (i.e. via the ``shrink`` kwarg).
77-
This has been changed so that the number of ticks is now responsive to how
78-
large the colorbar is.
75+
colorbar, but looked bad if the colorbar was made smaller (i.e. via the
76+
``shrink`` keyword argument). This has been changed so that the number of
77+
ticks is now responsive to how large the colorbar is.
7978

8079

8180

@@ -94,14 +93,14 @@ overwriting, especially when the figure name has been
9493
manually set using `.figure.Figure.canvas.set_window_title()`.
9594

9695

97-
Legend now has a *title_fontsize* kwarg (and rcParam)
98-
-----------------------------------------------------
96+
Legend now has a *title_fontsize* keyword argument (and rcParam)
97+
----------------------------------------------------------------
9998

100-
The title for a `.Figure.legend` and `.Axes.legend` can now have its
101-
fontsize set via the ``title_fontsize`` kwarg. There is also a new
102-
:rc:`legend.title_fontsize`. Both default to ``None``, which means
103-
the legend title will have the same fontsize as the axes default fontsize
104-
(*not* the legend fontsize, set by the ``fontsize`` kwarg or
99+
The title for a `.Figure.legend` and `.Axes.legend` can now have its fontsize
100+
set via the ``title_fontsize`` keyword argument. There is also a new
101+
:rc:`legend.title_fontsize`. Both default to ``None``, which means the legend
102+
title will have the same fontsize as the axes default fontsize (*not* the
103+
legend fontsize, set by the ``fontsize`` keyword argument or
105104
:rc:`legend.fontsize`).
106105

107106

doc/users/prev_whats_new/whats_new_3.2.0.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,9 @@ parameter.
8989

9090
Shifting errorbars
9191
------------------
92-
Previously, `~.Axes.errorbar()` accepted a kwarg *errorevery* such that the
93-
command ``plt.errorbar(x, y, yerr, errorevery=6)`` would add error bars to
94-
datapoints ``x[::6], y[::6]``.
92+
Previously, `~.Axes.errorbar()` accepted a keyword argument *errorevery* such
93+
that the command ``plt.errorbar(x, y, yerr, errorevery=6)`` would add error
94+
bars to datapoints ``x[::6], y[::6]``.
9595

9696
`~.Axes.errorbar()` now also accepts a tuple for *errorevery* such that
9797
``plt.errorbar(x, y, yerr, errorevery=(start, N))`` adds error bars to points

doc/users/prev_whats_new/whats_new_3.3.0.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -274,11 +274,11 @@ dropping the last row and column of *C*, and *x* and *y* are regarded as the
274274
edges of the remaining rows and columns in *C*. However, many users want
275275
*x* and *y* centered on the rows and columns of *C*.
276276

277-
To accommodate this, ``shading='nearest'`` and ``shading='auto'`` are
278-
new allowed strings for the ``shading`` kwarg. ``'nearest'`` will center the
279-
color on *x* and *y* if *x* and *y* have the same dimensions as *C*
280-
(otherwise an error will be thrown). ``shading='auto'`` will choose 'flat'
281-
or 'nearest' based on the size of *X*, *Y*, *C*.
277+
To accommodate this, ``shading='nearest'`` and ``shading='auto'`` are new
278+
allowed strings for the ``shading`` keyword argument. ``'nearest'`` will center
279+
the color on *x* and *y* if *x* and *y* have the same dimensions as *C*
280+
(otherwise an error will be thrown). ``shading='auto'`` will choose 'flat' or
281+
'nearest' based on the size of *X*, *Y*, *C*.
282282

283283
If ``shading='flat'`` then *X*, and *Y* should have dimensions one larger
284284
than *C*. If *X* and *Y* have the same dimensions as *C*, then the previous
@@ -296,20 +296,20 @@ for examples.
296296
Set zorder of contour labels
297297
----------------------------
298298

299-
`~.axes.Axes.clabel` now accepts a *zorder* kwarg
300-
making it easier to set the *zorder* of contour labels.
301-
If not specified, the default *zorder* of clabels used to always be 3
302-
(i.e. the default *zorder* of `~.text.Text`) irrespective of the *zorder*
303-
passed to `~.axes.Axes.contour`/`~.axes.Axes.contourf`.
304-
The new default *zorder* for clabels has been changed to (``2 + zorder``
305-
passed to `~.axes.Axes.contour` / `~.axes.Axes.contourf`).
299+
`~.axes.Axes.clabel` now accepts a *zorder* keyword argument making it easier
300+
to set the *zorder* of contour labels. If not specified, the default *zorder*
301+
of clabels used to always be 3 (i.e. the default *zorder* of `~.text.Text`)
302+
irrespective of the *zorder* passed to
303+
`~.axes.Axes.contour`/`~.axes.Axes.contourf`. The new default *zorder* for
304+
clabels has been changed to (``2 + zorder`` passed to `~.axes.Axes.contour` /
305+
`~.axes.Axes.contourf`).
306306

307307

308308
Simple syntax to select fonts by absolute path
309309
----------------------------------------------
310310

311311
Fonts can now be selected by passing an absolute `pathlib.Path` to the *font*
312-
kwarg of `.Text`.
312+
keyword argument of `.Text`.
313313

314314

315315
Add generalized "mathtext.fallback" rcParam

0 commit comments

Comments
 (0)