10000 numpydoc-ify SymLogNorm (#16270) · matplotlib/matplotlib@31ba9ff · GitHub
[go: up one dir, main page]

Skip to content
< 8000 div class="prc-PageHeader-PageHeader-sT1Hp">

Commit 31ba9ff

Browse files
authored
numpydoc-ify SymLogNorm (#16270)
numpydoc-ify SymLogNorm
2 parents ef57d9e + 6c53a23 commit 31ba9ff

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

lib/matplotlib/colors.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1197,18 +1197,18 @@ class SymLogNorm(Normalize):
11971197
def __init__(self, linthresh, linscale=1.0,
11981198
vmin=None, vmax=None, clip=False):
11991199
"""
1200-
*linthresh*:
1201-
The range within which the plot is linear (to
1202-
avoid having the plot go to infinity around zero).
1203-
1204-
*linscale*:
1205-
This allows the linear range (-*linthresh* to *linthresh*)
1206-
to be stretched relative to the logarithmic range. Its
1207-
value is the number of decades to use for each half of the
1208-
linear range. For example, when *linscale* == 1.0 (the
1209-
default), the space used for the positive and negative
1210-
halves of the linear range will be equal to one decade in
1211-
the logarithmic range. Defaults to 1.
1200+
Parameters
1201+
----------
1202+
linthresh : float
1203+
The range within which the plot is linear (to avoid having the plot
1204+
go to infinity around zero).
1205+
linscale : float, default: 1
1206+
This allows the linear range (-*linthresh* to *linthresh*) to be
1207+
stretched relative to the logarithmic range. Its value is the
1208+
number of decades to use for each half of the linear range. For
1209+
example, when *linscale* == 1.0 (the default), the space used for
1210+
the positive and negative halves of the linear range will be equal
1211+
to one decade in the logarithmic range.
12121212
"""
12131213
Normalize.__init__(self, vmin, vmax, clip)
12141214
self.linthresh = float(linthresh)

0 commit comments

Comments
 (0)
0