Skip to content

Commit 535941c

Browse files
committed
Add parameter docs for AutoDateFormatter.
1 parent 983dfe6 commit 535941c

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

lib/matplotlib/dates.py

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -905,9 +905,19 @@ class AutoDateFormatter(ticker.Formatter):
905905

906906
def __init__(self, locator, tz=None, defaultfmt='%Y-%m-%d'):
907907
"""
908-
Autoformat the date labels. The default format is the one to use
909-
if none of the values in ``self.scaled`` are greater than the unit
910-
returned by ``locator._get_unit()``.
908+
Autoformat the date labels.
909+
910+
Parameters
911+
----------
912+
locator : `.ticker.Locator`
913+
Locator that this axis is using.
914+
915+
tz : str, optional
916+
Passed to `.dates.date2num`.
917+
918+
defaultfmt : str
919+
The default format to use if none of the values in ``self.scaled``
920+
are greater than the unit returned by ``locator._get_unit()``.
911921
"""
912922
self._locator = locator
913923
self._tz = tz

0 commit comments

Comments
 (0)