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

Skip to content

Commit 86c7e6c

Browse files
committed
DOC: more copy-editing of the SymLogNorm docstring
1 parent 353379d commit 86c7e6c

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

lib/matplotlib/colors.py

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1218,16 +1218,19 @@ def __init__(self, linthresh, linscale=1.0, vmin=None, vmax=None,
12181218
The range within which the plot is linear (to avoid having the plot
12191219
go to infinity around zero).
12201220
linscale : float, default: 1
1221-
This allows the linear range (-*linthresh* to *linthresh*) to be
1222-
stretched relative to the logarithmic range. Its value is the
1223-
number of powers of *base* (decades for base 10) to use for each
1224-
half of the linear range. For example, when *linscale* == 1.0
1225-
(the default), the space used for the positive and negative halves
1226-
of the linear range will be equal to a decade in the logarithmic
1227-
range if ``base=10``.
1221+
This allows the linear range (-*linthresh* to *linthresh*)
1222+
to be stretched relative to the logarithmic range. Its
1223+
value is the number of powers of *base* to use for each
1224+
half of the linear range.
1225+
1226+
For example, when *linscale* == 1.0 (the default) and
1227+
``base=10``, then space used for the positive and negative
1228+
halves of the linear range will be equal to a decade in
1229+
the logarithmic.
1230+
12281231
base : float, default: None
1229-
If not given, defaults to ``np.e``, consistent with prior
1230-
behavior and warns.
1232+
If not given, defaults to ``np.e`` (consistent with prior
1233+
behavior) and warns.
12311234
12321235
In v3.3 the default value will change to 10 to be consistent with
12331236
`.SymLogNorm`.

0 commit comments

Comments
 (0)