Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 691fb7f

Browse filesBrowse files
jklymakjklymak
authored
Merge pull request #11699 from anntzer/overindentedrst
Dedent overindented rst bullet lists.
2 parents 3b0c96a + 1966f97 commit 691fb7f
Copy full SHA for 691fb7f

File tree

Expand file treeCollapse file tree

3 files changed

+72
-78
lines changed
Filter options
Expand file treeCollapse file tree

3 files changed

+72
-78
lines changed

‎doc/devel/add_new_projection.rst

Copy file name to clipboardExpand all lines: doc/devel/add_new_projection.rst
+41-45Lines changed: 41 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -39,24 +39,23 @@ Adding a new scale consists of defining a subclass of
3939
:class:`matplotlib.scale.ScaleBase`, that includes the following
4040
elements:
4141

42-
- A transformation from data coordinates into display coordinates.
42+
- A transformation from data coordinates into display coordinates.
4343

44-
- An inverse of that transformation. This is used, for example, to
45-
convert mouse positions from screen space back into data space.
44+
- An inverse of that transformation. This is used, for example, to
45+
convert mouse positions from screen space back into data space.
4646

47-
- A function to limit the range of the axis to acceptable values
48-
(``limit_range_for_scale()``). A log scale, for instance, would
49-
prevent the range from including values less than or equal to
50-
zero.
47+
- A function to limit the range of the axis to acceptable values
48+
(``limit_range_for_scale()``). A log scale, for instance, would
49+
prevent the range from including values less than or equal to zero.
5150

52-
- Locators (major and minor) that determine where to place ticks in
53-
the plot, and optionally, how to adjust the limits of the plot to
54-
some "good" values. Unlike ``limit_range_for_scale()``, which is
55-
always enforced, the range setting here is only used when
56-
automatically setting the range of the plot.
51+
- Locators (major and minor) that determine where to place ticks in
52+
the plot, and optionally, how to adjust the limits of the plot to
53+
some "good" values. Unlike ``limit_range_for_scale()``, which is
54+
always enforced, the range setting here is only used when
55+
automatically setting the range of the plot.
5756

58-
- Formatters (major and minor) that specify how the tick labels
59-
should be drawn.
57+
- Formatters (major and minor) that specify how the tick labels
58+
should be drawn.
6059

6160
Once the class is defined, it must be registered with matplotlib so
6261
that the user can select it.
@@ -75,51 +74,48 @@ Adding a new projection consists of defining a projection axes which
7574
subclasses :class:`matplotlib.axes.Axes` and includes the following
7675
elements:
7776

78-
- A transformation from data coordinates into display coordinates.
77+
- A transformation from data coordinates into display coordinates.
7978

80-
- An inverse of that transformation. This is used, for example, to
81-
convert mouse positions from screen space back into data space.
79+
- An inverse of that transformation. This is used, for example, to
80+
convert mouse positions from screen space back into data space.
8281

83-
- Transformations for the gridlines, ticks and ticklabels. Custom
84-
projections will often need to place these elements in special
85-
locations, and matplotlib has a facility to help with doing so.
82+
- Transformations for the gridlines, ticks and ticklabels. Custom
83+
projections will often need to place these elements in special
84+
locations, and matplotlib has a facility to help with doing so.
8685

87-
- Setting up default values (overriding
88-
:meth:`~matplotlib.axes.Axes.cla`), since the defaults for a
89-
rectilinear axes may not be appropriate.
86+
- Setting up default values (overriding :meth:`~matplotlib.axes.Axes.cla`),
87+
since the defaults for a rectilinear axes may not be appropriate.
9088

91-
- Defining the shape of the axes, for example, an elliptical axes,
92-
that will be used to draw the background of the plot and for
93-
clipping any data elements.
89+
- Defining the shape of the axes, for example, an elliptical axes, that will be
90+
used to draw the background of the plot and for clipping any data elements.
9491

95-
- Defining custom locators and formatters for the projection. For
96-
example, in a geographic projection, it may be more convenient to
97-
display the grid in degrees, even if the data is in radians.
92+
- Defining custom locators and formatters for the projection. For
93+
example, in a geographic projection, it may be more convenient to
94+
display the grid in degrees, even if the data is in radians.
9895

99-
- Set up interactive panning and zooming. This is left as an
100-
"advanced" feature left to the reader, but there is an example of
101-
this for polar plots in :mod:`matplotlib.projections.polar`.
96+
- Set up interactive panning and zooming. This is left as an
97+
"advanced" feature left to the reader, but there is an example of
98+
this for polar plots in :mod:`matplotlib.projections.polar`.
10299

103-
- Any additional methods for additional convenience or features.
100+
- Any additional methods for additional convenience or features.
104101

105102
Once the projection axes is defined, it can be used in one of two ways:
106103

107-
- By defining the class attribute ``name``, the projection axes can be
108-
registered with :func:`matplotlib.projections.register_projection`
109-
and subsequently simply invoked by name::
104+
- By defining the class attribute ``name``, the projection axes can be
105+
registered with :func:`matplotlib.projections.register_projection`
106+
and subsequently simply invoked by name::
110107

111-
plt.axes(projection='my_proj_name')
108+
plt.axes(projection='my_proj_name')
112109

113-
- For more complex, parameterisable projections, a generic "projection"
114-
object may be defined which includes the method ``_as_mpl_axes``.
115-
``_as_mpl_axes`` should take no arguments and return the projection's
116-
axes subclass and a dictionary of additional arguments to pass to the
117-
subclass' ``__init__`` method. Subsequently a parameterised projection
118-
can be initialised with::
110+
- For more complex, parameterisable projections, a generic "projection" object
111+
may be defined which includes the method ``_as_mpl_axes``. ``_as_mpl_axes``
112+
should take no arguments and return the projection's axes subclass and a
113+
dictionary of additional arguments to pass to the subclass' ``__init__``
114+
method. Subsequently a parameterised projection can be initialised with::
119115

120-
plt.axes(projection=MyProjection(param1=param1_value))
116+
plt.axes(projection=MyProjection(param1=param1_value))
121117

122-
where MyProjection is an object which implements a ``_as_mpl_axes`` method.
118+
where MyProjection is an object which implements a ``_as_mpl_axes`` method.
123119

124120

125121
A full-fledged and heavily annotated example is in

‎doc/devel/testing.rst

Copy file name to clipboardExpand all lines: doc/devel/testing.rst
+14-16Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@ local FreeType build
2525

2626
The following software is required to run the tests:
2727

28-
- pytest_ (>=3.4)
29-
- Ghostscript_ (to render PDF files)
30-
- Inkscape_ (to render SVG files)
28+
- pytest_ (>=3.4)
29+
- Ghostscript_ (to render PDF files)
30+
- Inkscape_ (to render SVG files)
3131

3232
Optionally you can install:
3333

34-
- pytest-cov_ (>=2.3.1) to collect coverage information
35-
- pytest-pep8_ to test coding standards
36-
- pytest-timeout_ to limit runtime in case of stuck tests
37-
- pytest-xdist_ to run tests in parallel
34+
- pytest-cov_ (>=2.3.1) to collect coverage information
35+
- pytest-pep8_ to test coding standards
36+
- pytest-timeout_ to limit runtime in case of stuck tests
37+
- pytest-xdist_ to run tests in parallel
3838

3939

4040
Running the tests
@@ -188,16 +188,14 @@ a feature dependent on that backend.
188188
There are two optional keyword arguments to the `image_comparison`
189189
decorator:
190190

191-
- `extensions`: If you only wish to test additional image formats
192-
(rather than just `png`), pass any additional file types in the
193-
list of the extensions to test. When copying the new
194-
baseline files be sure to only copy the output files, not their
195-
conversions to ``png``. For example only copy the files
196-
ending in ``pdf``, not in ``_pdf.png``.
191+
- `extensions`: If you only wish to test additional image formats (rather than
192+
just `png`), pass any additional file types in the list of the extensions to
193+
test. When copying the new baseline files be sure to only copy the output
194+
files, not their conversions to ``png``. For example only copy the files
195+
ending in ``pdf``, not in ``_pdf.png``.
197196

198-
- `tol`: This is the image matching tolerance, the default `1e-3`.
199-
If some variation is expected in the image between runs, this
200-
value may be adjusted.
197+
- `tol`: This is the image matching tolerance, the default `1e-3`. If some
198+
variation is expected in the image between runs, this value may be adjusted.
201199

202200
Known failing tests
203201
-------------------

‎doc/users/dflt_style_changes.rst

Copy file name to clipboardExpand all lines: doc/users/dflt_style_changes.rst
+17-17Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -275,12 +275,12 @@ Plotting functions
275275
The following changes were made to the default behavior of
276276
`~matplotlib.axes.Axes.scatter`
277277

278-
- The default size of the elements in a scatter plot is now based on
279-
the rcParam ``lines.markersize`` so it is consistent with ``plot(X,
280-
Y, 'o')``. The old value was 20, and the new value is 36 (6^2).
281-
- scatter markers no longer have a black edge.
282-
- if the color of the markers is not specified it will follow the
283-
property cycle, pulling from the 'patches' cycle on the ``Axes``.
278+
- The default size of the elements in a scatter plot is now based on
279+
the rcParam ``lines.markersize`` so it is consistent with ``plot(X,
280+
Y, 'o')``. The old value was 20, and the new value is 36 (6^2).
281+
- Scatter markers no longer have a black edge.
282+
- If the color of the markers is not specified it will follow the
283+
property cycle, pulling from the 'patches' cycle on the ``Axes``.
284284

285285
.. plot::
286286

@@ -323,10 +323,10 @@ a per-call basis pass the following kwargs::
323323
The following changes were made to the default behavior of
324324
`~matplotlib.axes.Axes.plot`
325325

326-
- the default linewidth increased from 1 to 1.5
327-
- the dash patterns associated with ``'--'``, ``':'``, and ``'-.'`` have
328-
changed
329-
- the dash patterns now scale with line width
326+
- the default linewidth increased from 1 to 1.5
327+
- the dash patterns associated with ``'--'``, ``':'``, and ``'-.'`` have
328+
changed
329+
- the dash patterns now scale with line width
330330

331331

332332
.. plot::
@@ -642,18 +642,18 @@ Hatching
642642

643643
The color of the lines in the hatch is now determined by
644644

645-
- If an edge color is explicitly set, use that for the hatch color
646-
- If the edge color is not explicitly set, use ``rcParam['hatch.color']`` which
647-
is looked up at artist creation time.
645+
- If an edge color is explicitly set, use that for the hatch color
646+
- If the edge color is not explicitly set, use ``rcParam['hatch.color']`` which
647+
is looked up at artist creation time.
648648

649649
The width of the lines in a hatch pattern is now configurable by the
650650
rcParams `hatch.linewidth`, which defaults to 1 point. The old
651651
behavior for the line width was different depending on backend:
652652

653-
- PDF: 0.1 pt
654-
- SVG: 1.0 pt
655-
- PS: 1 px
656-
- Agg: 1 px
653+
- PDF: 0.1 pt
654+
- SVG: 1.0 pt
655+
- PS: 1 px
656+
- Agg: 1 px
657657

658658
The old line width behavior can not be restored across all backends
659659
simultaneously, but can be restored for a single backend by setting::

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.