diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py index 6cdb1294ebca..533a206d54eb 100644 --- a/lib/matplotlib/ticker.py +++ b/lib/matplotlib/ticker.py @@ -1833,14 +1833,14 @@ 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 @@ -1848,17 +1848,15 @@ def __init__(self, *args, **kwargs): 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 @@ -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: