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

Skip to content

Commit e65b522

Browse files
committed
DOC: standardize rst markup
1 parent 1e601f7 commit e65b522

17 files changed

+22
-19
lines changed

doc/users/next_whats_new/2018-09-19-AL.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
:orphan:
2-
31
`matplotlib.rc_context` is now a `contextlib.contextmanager`
4-
````````````````````````````````````````````````````````````
2+
------------------------------------------------------------
53

64
`matplotlib.rc_context` can now be used as a decorator (technically, it is now
75
implemented as a `contextlib.contextmanager`), e.g. ::

doc/users/next_whats_new/2019-06-01-AL.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
GridSpec.subplots()
2-
```````````````````
2+
-------------------
33

44
The `.GridSpec` class gained a `~.GridSpecBase.subplots` method, so that one
55
can write ::
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
3D axes now support minor ticks
2-
```````````````````````````````
2+
-------------------------------

doc/users/next_whats_new/2019-07-31_axes-box-aspect.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
:orphan:
21

32
Setting axes box aspect
43
-----------------------
Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
:orphan:
21

32
rcParams for controlling default "raise window" behavior
43
--------------------------------------------------------
54
The new config option :rc:`figure.raise_window` allows to disable
65
raising the plot window when calling `~.pyplot.show` or `~.pyplot.pause`.
76
``MacOSX`` backend is currently not supported.
8-

doc/users/next_whats_new/2019-12-20-set_xy_position

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
Align labels to axes edges
22
--------------------------
3+
34
`~.axes.Axes.set_xlabel`, `~.axes.Axes.set_ylabel` and `ColorbarBase.set_label`
45
support a parameter ``loc`` for simplified positioning. Supported values are
56
'left', 'center', or 'right'. The default is controlled via

doc/users/next_whats_new/2020-01-24-lateshare.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
`.Axes.sharex`, `.Axes.sharey`
22
------------------------------
3+
34
These new methods allow sharing axes *immediately* after creating them. For
45
example, they can be used to selectively link some axes created all together
56
using `~.Figure.subplots`.

doc/users/next_whats_new/2020-01-25-clabel_zorder.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
Set zorder of contour labels
22
----------------------------
3+
34
`~.axes.Axes.clabel` now accepts a ``zorder`` kwarg
45
making it easier to set the ``zorder`` of contour labels.
56
If not specified, the default ``zorder`` of clabels used to always be 3
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Simple syntax to select fonts by absolute path
2-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2+
----------------------------------------------
33

44
Fonts can now be selected by passing an absolute `pathlib.Path` to the *font*
55
kwarg of `.Text`.
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
Add generalized "mathtext.fallback" rcParam
2-
------------------------------------------------------------------------
2+
-------------------------------------------
3+
34
New "mathtext.fallback" rcParam. Takes "cm", "stix", "stixsans"
45
or "none" to turn fallback off. "mathtext.fallback_to_cm" is
5-
deprecated, but if used, will override new fallback.
6+
deprecated, but if used, will override new fallback.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Lines now accept ``MarkerStyle`` instances as input
22
---------------------------------------------------
3+
34
Similar to `~.Axes.scatter`, `~.Axes.plot` and `~.lines.Line2D` now accept
45
`~.markers.MarkerStyle` instances as input for the *marker* parameter::
56

67
plt.plot(..., marker=matplotlib.markers.MarkerStyle("D"))
7-

doc/users/next_whats_new/2020-03-06-auto-tick-formatters.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
Allow tick formatters to be set with str or function inputs
2-
------------------------------------------------------------------------
2+
-----------------------------------------------------------
3+
34
`~.Axis.set_major_formatter` and `~.Axis.set_minor_formatter`
45
now accept `str` or function inputs in addition to `~.ticker.Formatter`
56
instances. For a `str` a `~.ticker.StrMethodFormatter` is automatically

doc/users/next_whats_new/2020-03-15-cursor-sigdigits.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Cursor text now uses a number of significant digits matching pointing precision
2-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2+
-------------------------------------------------------------------------------
33

44
Previously, the x/y position displayed by the cursor text would usually include
55
far more significant digits than the mouse pointing precision (typically one

doc/users/next_whats_new/2020-04-13-AL.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
`.backend_bases.key_press_handler` and `.backend_bases.button_press_handler` simplifications
2-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2+
--------------------------------------------------------------------------------------------
3+
34
These event handlers can now be directly connected to a canvas with
45
``canvas.mpl_connect("key_press_event", key_press_handler)`` and
56
``canvas.mpl_connect("button_press_event", button_press_handler)``, rather than
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
`~.axes.Axes.set_title` gains a y keyword argument to control auto positioning
22
------------------------------------------------------------------------------
3+
34
`~.axes.Axes.set_title` tries to auto-position the title to avoid any
45
decorators on the top x-axis. This is not always desirable so now
56
*y* is an explicit keyword argument of `~.axes.Axes.set_title`. It
67
defaults to *None* which means to use auto-positioning. If a value is
78
supplied (i.e. the pre-3.0 default was ``y=1.0``) then auto-positioning is
8-
turned off. This can also be set with the new rcParameter :rc:`axes.titley`.
9+
turned off. This can also be set with the new rcParameter :rc:`axes.titley`.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
tight_layout now supports suptitle
2-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2+
----------------------------------
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
Imshow now coerces 3D arrays with depth 1 to 2D
22
------------------------------------------------
3-
Starting from this version arrays of size MxNx1 will be coerced into MxN
4-
for displaying. This means commands like ``plt.imshow(np.random.rand(3, 3, 1))``
3+
4+
Starting from this version arrays of size MxNx1 will be coerced into MxN
5+
for displaying. This means commands like ``plt.imshow(np.random.rand(3, 3, 1))``
56
will no longer return an error message that the image shape is invalid.

0 commit comments

Comments
 (0)