8000 Doc: Remove hard-documented rcParams defaults (#15230) · matplotlib/matplotlib@289130d · GitHub
[go: up one dir, main page]
Skip to content

Commit 289130d

Browse files
timhoffmImportanceOfBeingErnest
timhoffm
authored and
ImportanceOfBeingErnest
committed
Doc: Remove hard-documented rcParams defaults (#15230)
1 parent 98507c0 commit 289130d

File tree

6 files changed

+14
-16
lines changed

6 files changed

+14
-16
lines changed

‎examples/images_contours_and_fields/interpolation_methods.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@
66
This example displays the difference between interpolation methods for
77
:meth:`~.axes.Axes.imshow`.
88
9-
If *interpolation* is None, it defaults to the :rc:`image.interpolation`
10-
(default: ``'nearest'``). If the interpolation is ``'none'``, then no
11-
interpolation is performed for the Agg, ps and pdf backends. Other backends
12-
will default to ``'antialiased'``.
9+
If *interpolation* is None, it defaults to the :rc:`image.interpolation`.
10+
If the interpolation is ``'none'``, then no interpolation is performed for the
11+
Agg, ps and pdf backends. Other backends will default to ``'antialiased'``.
1312
1413
For the Agg, ps and pdf backends, ``interpolation = 'none'`` works well when a
1514
big image is scaled down, while ``interpolation = 'nearest'`` works well when

‎examples/text_labels_and 8000 _annotations/unicode_minus.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
By default, tick labels at negative values are rendered using a `Unicode
77
minus`__ (U+2212) rather than an ASCII hyphen (U+002D). This can be controlled
8-
by setting :rc:`axes.unicode_minus` (which defaults to True).
8+
by setting :rc:`axes.unicode_minus`.
99
1010
__ https://en.wikipedia.org/wiki/Plus_and_minus_signs#Character_codes
1111

‎examples/ticks_and_spines/tick_xlabel_top.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@
33
Set default x-axis tick labels on the top
44
==========================================
55
6-
We can use :rc:`xtick.labeltop` (default False) and :rc:`xtick.top`
7-
(default False) and :rc:`xtick.labelbottom` (default True) and
8-
:rc:`xtick.bottom` (default True) to control where on the axes ticks and
9-
their labels appear.
6+
We can use :rc:`xtick.labeltop` and :rc:`xtick.top` and :rc:`xtick.labelbottom`
7+
and :rc:`xtick.bottom` to control where on the axes ticks and their labels
8+
appear.
109
1110
These properties can also be set in ``.matplotlib/matplotlibrc``.
1211
"""

‎lib/matplotlib/axes/_axes.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5469,11 +5469,11 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
54695469
that the data fit in the axes. In general, this will result in
54705470
non-square pixels.
54715471
5472-
If not given, use :rc:`image.aspect` (default: 'equal').
5472+
If not given, use :rc:`image.aspect`.
54735473
54745474
interpolation : str, optional
5475-
The interpolation method used. If *None*
5476-
:rc:`image.interpolation` is used, which defaults to 'nearest'.
5475+
The interpolation method used. If *None*, :rc:`image.interpolation`
5476+
is used.
54775477
54785478
Supported values are 'none', 'antialiased', 'nearest', 'bilinear',
54795479
'bicubic', 'spline16', 'spline36', 'hanning', 'hamming', 'hermite',
@@ -5782,7 +5782,7 @@ def pcolor(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
57825782
*edgecolors*\ ="none" is used. This eliminates artificial lines
57835783
at patch boundaries, and works regardless of the value of alpha.
57845784
If *edgecolors* is not "none", then the default *antialiaseds*
5785-
is taken from :rc:`patch.antialiased`, which defaults to True.
5785+
is taken from :rc:`patch.antialiased`.
57865786
Stroking the edges may be preferred if *alpha* is 1, but will
57875787
cause artifacts otherwise.
57885788
@@ -7650,7 +7650,7 @@ def spy(self, Z, precision=0, marker=None, markersize=None,
76507650
- 'auto': The axes is kept fixed and the aspect is adjusted so
76517651
that the data fit in the axes. In general, this will result in
76527652
non-square pixels.
7653-
- *None*: Use :rc:`image.aspect` (default: 'equal').
7653+
- *None*: Use :rc:`image.aspect`.
76547654
76557655
Default: 'equal'
76567656

‎lib/matplotlib/contour.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1626,7 +1626,7 @@ def _initialize_x_y(self, z):
16261626
nearest those points are always masked out, other triangular
16271627
corners comprising three unmasked points are contoured as usual.
16281628
1629-
Defaults to :rc:`contour.corner_mask`, which defaults to ``True``.
1629+
Defaults to :rc:`contour.corner_mask`.
16301630
16311631
colors : color string or sequence of colors, optional
16321632
The colors of the levels, i.e. the lines for `.contour` and the

‎lib/matplotlib/figure.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2100,7 +2100,7 @@ def savefig(self, fname, *, transparent=None, **kwargs):
21002100
quality : [ *None* | 1 <= scalar <= 100 ]
21012101
The image quality, on a scale from 1 (worst) to 95 (best).
21022102
Applicable only if *format* is jpg or jpeg, ignored otherwise.
2103-
If *None*, defaults to :rc:`savefig.jpeg_quality` (95 by default).
2103+
If *None*, defaults to :rc:`savefig.jpeg_quality`.
21042104
Values above 95 should be avoided; 100 completely disables the
21052105
JPEG quantization stage.
21062106

0 commit comments

Comments
 (0)
0