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 a833a36

Browse filesBrowse files
authored
Merge pull request #14290 from dstansby/numpydoc-symlog
Convert SymmetricalLogScale to numpydoc
2 parents 4a0d9c5 + b9f047a commit a833a36
Copy full SHA for a833a36

File tree

Expand file treeCollapse file tree

1 file changed

+22
-26
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+22
-26
lines changed

‎lib/matplotlib/scale.py

Copy file name to clipboardExpand all lines: lib/matplotlib/scale.py
+22-26Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -538,39 +538,35 @@ class SymmetricalLogScale(ScaleBase):
538538
need to have a range around zero that is linear. The parameter
539539
*linthresh* allows the user to specify the size of this range
540540
(-*linthresh*, *linthresh*).
541+
542+
Parameters
543+
----------
544+
basex, basey : float
545+
The base of the logarithm. Defaults to 10.
546+
547+
linthreshx, linthreshy : float
548+
Defines the range ``(-x, x)``, within which the plot is linear.
549+
This avoids having the plot go to infinity around zero. Defaults to 2.
550+
551+
subsx, subsy : sequence of int
552+
Where to place the subticks between each major tick.
553+
For example, in a log10 scale: ``[2, 3, 4, 5, 6, 7, 8, 9]`` will place
554+
8 logarithmically spaced minor ticks between each major tick.
555+
556+
linscalex, linscaley : float, optional
557+
This allows the linear range ``(-linthresh, linthresh)`` to be
558+
stretched relative to the logarithmic range. Its value is the number of
559+
decades to use for each half of the linear range. For example, when
560+
*linscale* == 1.0 (the default), the space used for the positive and
561+
negative halves of the linear range will be equal to one decade in
562+
the logarithmic range.
541563
"""
542564
name = 'symlog'
543565
# compatibility shim
544566
SymmetricalLogTransform = SymmetricalLogTransform
545567
InvertedSymmetricalLogTransform = InvertedSymmetricalLogTransform
546568

547569
def __init__(self, axis, **kwargs):
548-
"""
549-
*basex*/*basey*:
550-
The base of the logarithm
551-
552-
*linthreshx*/*linthreshy*:
553-
A single float which defines the range (-*x*, *x*), within
554-
which the plot is linear. This avoids having the plot go to
555-
infinity around zero.
556-
557-
*subsx*/*subsy*:
558-
Where to place the subticks between each major tick.
559-
Should be a sequence of integers. For example, in a log10
560-
scale: ``[2, 3, 4, 5, 6, 7, 8, 9]``
561-
562-
will place 8 logarithmically spaced minor ticks between
563-
each major tick.
564-
565-
*linscalex*/*linscaley*:
566-
This allows the linear range (-*linthresh* to *linthresh*)
567-
to be stretched relative to the logarithmic range. Its
568-
value is the number of decades to use for each half of the
569-
linear range. For example, when *linscale* == 1.0 (the
570-
default), the space used for the positive and negative
571-
halves of the linear range will be equal to one decade in
572-
the logarithmic range.
573-
"""
574570
if axis.axis_name == 'x':
575571
base = kwargs.pop('basex', 10.0)
576572
linthresh = kwargs.pop('linthreshx', 2.0)

0 commit comments

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