Skip to content

Commit fab9991

Browse files
QuLogicQuLogic
committed
Use correct styling for arguments in recent what's new.
1 parent e51c507 commit fab9991

File tree

3 files changed

+30
-33
lines changed

3 files changed

+30
-33
lines changed

‎doc/users/prev_whats_new/whats_new_3.0.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ Colorbar ticks can now be automatic
7373

7474
The number of ticks placed on colorbars was previously appropriate for a large
7575
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.
76+
*shrink* keyword argument). This has been changed so that the number of ticks
77+
is now responsive to how large the colorbar is.
7878

7979

8080

@@ -97,10 +97,10 @@ Legend now has a *title_fontsize* keyword argument (and rcParam)
9797
----------------------------------------------------------------
9898

9999
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
100+
set via the *title_fontsize* keyword argument. There is also a new
101101
:rc:`legend.title_fontsize`. Both default to ``None``, which means the legend
102102
title will have the same fontsize as the axes default fontsize (*not* the
103-
legend fontsize, set by the ``fontsize`` keyword argument or
103+
legend fontsize, set by the *fontsize* keyword argument or
104104
:rc:`legend.fontsize`).
105105

106106

‎doc/users/prev_whats_new/whats_new_3.1.0.rst

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -175,12 +175,11 @@ changed.
175175
`.ConnectionPatch` accepts arbitrary transforms
176176
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
177177

178-
Alternatively to strings like ``"data"`` or ``"axes fraction"``
179-
`ConnectionPatch` now accepts any `~matplotlib.transforms.Transform`
180-
as input for the ``coordsA`` and ``coordsB`` argument. This allows to
181-
draw lines between points defined in different user defined coordinate
182-
systems. Also see the :doc:`Connect Simple01 example
183-
</gallery/userdemo/connect_simple01>`.
178+
Alternatively to strings like ``"data"`` or ``"axes fraction"``,
179+
`ConnectionPatch` now accepts any `~matplotlib.transforms.Transform` as input
180+
for the *coordsA* and *coordsB* arguments. This allows to draw lines between
181+
points defined in different user defined coordinate systems. Also see the
182+
:doc:`Connect Simple01 example </gallery/userdemo/connect_simple01>`.
184183

185184

186185
mplot3d Line3D now allows {set,get}_data_3d
@@ -260,11 +259,10 @@ Default minor tick spacing was changed from 0.625 to 0.5 for major ticks spaced
260259
`.EngFormatter` now accepts *usetex*, *useMathText* as keyword only arguments
261260
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
262261

263-
A public API has been added to `.EngFormatter` to control how the
264-
numbers in the ticklabels will be rendered. By default,
265-
``useMathText`` evaluates to
266-
:rc:`axes.formatter.use_mathtext'` and ``usetex`` evaluates
267-
to :rc:`'text.usetex'`.
262+
A public API has been added to `.EngFormatter` to control how the numbers in
263+
the ticklabels will be rendered. By default, *useMathText* evaluates to
264+
:rc:`axes.formatter.use_mathtext'` and *usetex* evaluates to
265+
:rc:`'text.usetex'`.
268266

269267
If either is `True` then the numbers will be encapsulated by ``$``
270268
signs. When using ``TeX`` this implies that the numbers will be shown

‎doc/users/prev_whats_new/whats_new_3.3.0.rst

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -138,15 +138,14 @@ takes the rcParam based on its orientation.
138138
New "extend" keyword to colors.BoundaryNorm
139139
-------------------------------------------
140140

141-
`~.colors.BoundaryNorm` now has an ``extend`` keyword argument, analogous to
142-
``extend`` in `~.axes.Axes.contourf`. When set to 'both', 'min', or 'max',
143-
it maps the corresponding out-of-range values to `~.colors.Colormap`
144-
lookup-table indices near the appropriate ends of their range so that the
145-
colors for out-of range values are adjacent to, but distinct from, their
146-
in-range neighbors. The colorbar inherits the ``extend`` argument from the
147-
norm, so with ``extend='both'``, for example, the colorbar will have triangular
148-
extensions for out-of-range values with colors that differ from adjacent in-range
149-
colors.
141+
`~.colors.BoundaryNorm` now has an *extend* keyword argument, analogous to
142+
*extend* in `~.axes.Axes.contourf`. When set to 'both', 'min', or 'max', it
143+
maps the corresponding out-of-range values to `~.colors.Colormap` lookup-table
144+
indices near the appropriate ends of their range so that the colors for out-of
145+
range values are adjacent to, but distinct from, their in-range neighbors. The
146+
colorbar inherits the *extend* argument from the norm, so with
147+
``extend='both'``, for example, the colorbar will have triangular extensions
148+
for out-of-range values with colors that differ from adjacent in-range colors.
150149

151150
.. plot::
152151

@@ -251,10 +250,10 @@ Home/Forward/Backward buttons now work with 3D axes
251250

252251

253252

254-
``savefig()`` gained a ``backend`` keyword argument
255-
---------------------------------------------------
253+
``savefig()`` gained a *backend* keyword argument
254+
-------------------------------------------------
256255

257-
The ``backend`` keyword argument to ``savefig`` can now be used to pick the
256+
The *backend* keyword argument to ``savefig`` can now be used to pick the
258257
rendering backend without having to globally set the backend; e.g. one can save
259258
pdfs using the pgf backend with ``savefig("file.pdf", backend="pgf")``.
260259

@@ -275,7 +274,7 @@ edges of the remaining rows and columns in *C*. However, many users want
275274
*x* and *y* centered on the rows and columns of *C*.
276275

277276
To accommodate this, ``shading='nearest'`` and ``shading='auto'`` are new
278-
allowed strings for the ``shading`` keyword argument. ``'nearest'`` will center
277+
allowed strings for the *shading* keyword argument. ``'nearest'`` will center
279278
the color on *x* and *y* if *x* and *y* have the same dimensions as *C*
280279
(otherwise an error will be thrown). ``shading='auto'`` will choose 'flat' or
281280
'nearest' based on the size of *X*, *Y*, *C*.
@@ -397,8 +396,8 @@ conversion (using the new epoch) is::
397396

398397

399398

400-
`~.axes.Axes.set_title` gains a y keyword argument to control auto positioning
401-
------------------------------------------------------------------------------
399+
`~.axes.Axes.set_title` gains a *y* keyword argument to control auto positioning
400+
--------------------------------------------------------------------------------
402401

403402
`~.axes.Axes.set_title` tries to auto-position the title to avoid any
404403
decorators on the top x-axis. This is not always desirable so now
@@ -417,9 +416,9 @@ Add :rc:`contour.linewidth` to rcParams
417416

418417
The new config option :rc:`contour.linewidth` allows to control the default
419418
linewidth of contours as a float. When set to ``None``, the linewidths fall
420-
back to :rc:`lines.linewidth`. The config value is overidden as usual
421-
by the ``linewidths`` argument passed to `~.axes.Axes.contour` when
422-
it is not set to ``None``.
419+
back to :rc:`lines.linewidth`. The config value is overidden as usual by the
420+
*linewidths* argument passed to `~.axes.Axes.contour` when it is not set to
421+
``None``.
423422

424423

425424
The SVG backend can now render hatches with transparency

0 commit comments

Comments
 (0)