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 21a4955

Browse filesBrowse files
DerWehtacaswell
authored andcommitted
MAINT: Move docstring of LogLocator to class
Doc string is not accessible to some IDE tools if it is placed on `__init__` instead of on class.
1 parent eb92923 commit 21a4955
Copy full SHA for 21a4955

File tree

Expand file treeCollapse file tree

1 file changed

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

1 file changed

+28
-26
lines changed

‎lib/matplotlib/ticker.py

Copy file name to clipboardExpand all lines: lib/matplotlib/ticker.py
+28-26Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2255,35 +2255,37 @@ def _is_close_to_int(x):
22552255

22562256
class LogLocator(Locator):
22572257
"""
2258-
Determine the tick locations for log axes
2258+
2259+
Determine the tick locations for log axes.
2260+
2261+
Place ticks on the locations : ``subs[j] * base**i``
2262+
2263+
Parameters
2264+
----------
2265+
base : float, default: 10.0
2266+
The base of the log used, so major ticks are placed at
2267+
``base**n``, where ``n`` is an integer.
2268+
subs : None or {'auto', 'all'} or sequence of float, default: (1.0,)
2269+
Gives the multiples of integer powers of the base at which
2270+
to place ticks. The default of ``(1.0, )`` places ticks only at
2271+
integer powers of the base.
2272+
Permitted string values are ``'auto'`` and ``'all'``.
2273+
Both of these use an algorithm based on the axis view
2274+
limits to determine whether and how to put ticks between
2275+
integer powers of the base. With ``'auto'``, ticks are
2276+
placed only between integer powers; with ``'all'``, the
2277+
integer powers are included. A value of None is
2278+
equivalent to ``'auto'``.
2279+
numticks : None or int, default: None
2280+
The maximum number of ticks to allow on a given axis. The default
2281+
of ``None`` will try to choose intelligently as long as this
2282+
Locator has already been assigned to an axis using
2283+
`~.axis.Axis.get_tick_space`, but otherwise falls back to 9.
2284+
22592285
"""
22602286

22612287
def __init__(self, base=10.0, subs=(1.0,), numdecs=4, numticks=None):
2262-
"""
2263-
Place ticks at values ``subs[j] * base**n``.
2264-
2265-
Parameters
2266-
----------
2267-
base : float, default: 10.0
2268-
The base of the log used, so major ticks are placed at
2269-
``base**n``, where ``n`` is an integer.
2270-
subs : None or {'auto', 'all'} or sequence of float, default: (1.0,)
2271-
Gives the multiples of integer powers of the base at which
2272-
to place ticks. The default of ``(1.0, )`` places ticks only at
2273-
integer powers of the base.
2274-
Permitted string values are ``'auto'`` and ``'all'``.
2275-
Both of these use an algorithm based on the axis view
2276-
limits to determine whether and how to put ticks between
2277-
integer powers of the base. With ``'auto'``, ticks are
2278-
placed only between integer powers; with ``'all'``, the
2279-
integer powers are included. A value of None is
2280-
equivalent to ``'auto'``.
2281-
numticks : None or int, default: None
2282-
The maximum number of ticks to allow on a given axis. The default
2283-
of ``None`` will try to choose intelligently as long as this
2284-
Locator has already been assigned to an axis using
2285-
`~.axis.Axis.get_tick_space`, but otherwise falls back to 9.
2286-
"""
2288+
"""Place ticks on the locations : subs[j] * base**i."""
22872289
if numticks is None:
22882290
if mpl.rcParams['_internal.classic_mode']:
22892291
numticks = 15

0 commit comments

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