Skip to content

Tweak AutoMinorLocator docstring. #29128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Tweak AutoMinorLocator docstring. #29128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions lib/matplotlib/ticker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2930,20 +2930,21 @@ class AutoMinorLocator(Locator):
Place evenly spaced minor ticks, with the step size and maximum number of ticks
chosen automatically.

The Axis scale must be linear with evenly spaced major ticks .
The Axis must use a linear scale and have evenly spaced major ticks.
"""

def __init__(self, n=None):
"""
*n* is the number of subdivisions of the interval between
major ticks; e.g., n=2 will place a single minor tick midway
between major ticks.

If *n* is omitted or None, the value stored in rcParams will be used.
In case *n* is set to 'auto', it will be set to 4 or 5. If the distance
between the major ticks equals 1, 2.5, 5 or 10 it can be perfectly
divided in 5 equidistant sub-intervals with a length multiple of
0.05. Otherwise it is divided in 4 sub-intervals.
Parameters
----------
n : int or 'auto', default: :rc:`xtick.minor.ndivs` or :rc:`ytick.minor.ndivs`
The number of subdivisions of the interval between major ticks;
e.g., n=2 will place a single minor tick midway between major ticks.

If *n* is 'auto', it will be set to 4 or 5: if the distance
between the major ticks equals 1, 2.5, 5 or 10 it can be perfectly
divided in 5 equidistant sub-intervals with a length multiple of
0.05; otherwise, it is divided in 4 sub-intervals.
"""
self.ndivs = n

Expand Down
Loading