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

Skip to content

Format MaxNLocator with numpydoc #12999

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
Dec 17, 2018
Merged

Format MaxNLocator with numpydoc #12999

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
24 changes: 11 additions & 13 deletions lib/matplotlib/ticker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1833,32 +1833,30 @@ class MaxNLocator(Locator):

def __init__(self, *args, **kwargs):
"""
Keyword args:

*nbins*
Parameters
----------
nbins : int or 'auto', optional, default: 10
Maximum number of intervals; one less than max number of
ticks. If the string `'auto'`, the number of bins will be
automatically determined based on the length of the axis.

*steps*
steps: array-like, optional
Sequence of nice numbers starting with 1 and ending with 10;
e.g., [1, 2, 4, 5, 10], where the values are acceptable
tick multiples. i.e. for the example, 20, 40, 60 would be
an acceptable set of ticks, as would 0.4, 0.6, 0.8, because
they are multiples of 2. However, 30, 60, 90 would not
be allowed because 3 does not appear in the list of steps.

*integer*
integer : bool, optional, default: False
If True, ticks will take only integer values, provided
at least `min_n_ticks` integers are found within the
view limits.

*symmetric*
If True, autoscaling will result in a range symmetric
about zero.
symmetric : bool, optional, default: False
If True, autoscaling will result in a range symmetric about zero.

*prune*
['lower' | 'upper' | 'both' | None]
prune : {'lower', 'upper', 'both', None}, optional, default: None
Remove edge ticks -- useful for stacked or ganged plots where
the upper tick of one axes overlaps with the lower tick of the
axes above it, primarily when :rc:`axes.autolimit_mode` is
Expand All @@ -1867,9 +1865,9 @@ def __init__(self, *args, **kwargs):
removed. If ``prune == 'both'``, the largest and smallest ticks
will be removed. If ``prune == None``, no ticks will be removed.

*min_n_ticks*
Relax `nbins` and `integer` constraints if necessary to
obtain this minimum number of ticks.
min_n_ticks : int, optional, default: 2
Relax *nbins* and *integer* constraints if necessary to obtain
this minimum number of ticks.

"""
if args:
Expand Down