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 0817c66

Browse filesBrowse files
authored
Merge pull request #9192 from dstansby/set-tick-docstrings
Convert tick-setting methods to docstrings
2 parents 4b50e49 + b4acccf commit 0817c66
Copy full SHA for 0817c66

File tree

Expand file treeCollapse file tree

1 file changed

+47
-18
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+47
-18
lines changed

‎lib/matplotlib/axes/_base.py

Copy file name to clipboardExpand all lines: lib/matplotlib/axes/_base.py
+47-18Lines changed: 47 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2993,24 +2993,39 @@ def set_xticks(self, ticks, minor=False):
29932993
"""
29942994
Set the x ticks with list of *ticks*
29952995
2996-
ACCEPTS: sequence of floats
2996+
Parameters
2997+
----------
2998+
ticks : list
2999+
List of x-axis tick locations
3000+
3001+
minor : bool, optional
3002+
If ``False`` sets major ticks, if ``True`` sets minor ticks.
3003+
Default is ``False``.
29973004
"""
29983005
ret = self.xaxis.set_ticks(ticks, minor=minor)
29993006
self.stale = True
30003007
return ret
30013008

30023009
def get_xmajorticklabels(self):
30033010
"""
3004-
Get the xtick labels as a list of :class:`~matplotlib.text.Text`
3005-
instances.
3011+
Get the xtick major labels
3012+
3013+
Returns
3014+
-------
3015+
labels : list
3016+
List of :class:`~matplotlib.text.Text` instances
30063017
"""
30073018
return cbook.silent_list('Text xticklabel',
30083019
self.xaxis.get_majorticklabels())
30093020

30103021
def get_xminorticklabels(self):
30113022
"""
3012-
Get the x minor tick labels as a list of
3013-
:class:`matplotlib.text.Text` instances.
3023+
Get the x minor tick labels
3024+
3025+
Returns
3026+
-------
3027+
labels : list
3028+
List of :class:`~matplotlib.text.Text` instances
30143029
"""
30153030
return cbook.silent_list('Text xticklabel',
30163031
self.xaxis.get_minorticklabels())
@@ -3299,28 +3314,38 @@ def set_yticks(self, ticks, minor=False):
32993314
"""
33003315
Set the y ticks with list of *ticks*
33013316
3302-
ACCEPTS: sequence of floats
3303-
3304-
Keyword arguments:
3317+
Parameters
3318+
----------
3319+
ticks : sequence
3320+
List of y-axis tick locations
33053321
3306-
*minor*: [ *False* | *True* ]
3307-
Sets the minor ticks if *True*
3322+
minor : bool, optional
3323+
If ``False`` sets major ticks, if ``True`` sets minor ticks.
3324+
Default is ``False``.
33083325
"""
33093326
ret = self.yaxis.set_ticks(ticks, minor=minor)
33103327
return ret
33113328

33123329
def get_ymajorticklabels(self):
33133330
"""
3314-
Get the major y tick labels as a list of
3315-
:class:`~matplotlib.text.Text` instances.
3331+
Get the major y tick labels
3332+
3333+
Returns
3334+
-------
3335+
labels : list
3336+
List of :class:`~matplotlib.text.Text` instances
33163337
"""
33173338
return cbook.silent_list('Text yticklabel',
33183339
self.yaxis.get_majorticklabels())
33193340

33203341
def get_yminorticklabels(self):
33213342
"""
3322-
Get the minor y tick labels as a list of
3323-
:class:`~matplotlib.text.Text` instances.
3343+
Get the minor y tick labels
3344+
3345+
Returns
3346+
-------
3347+
labels : list
3348+
List of :class:`~matplotlib.text.Text` instances
33243349
"""
33253350
return cbook.silent_list('Text yticklabel',
33263351
self.yaxis.get_minorticklabels())
@@ -3389,8 +3414,10 @@ def xaxis_date(self, tz=None):
33893414
"""
33903415
Sets up x-axis ticks and labels that treat the x data as dates.
33913416
3392-
*tz* is a timezone string or :class:`tzinfo` instance.
3393-
Defaults to rc value.
3417+
Parameters
3418+
----------
3419+
tz : string or :class:`tzinfo` instance, optional
3420+
Timezone string or timezone. Defaults to rc value.
33943421
"""
33953422
# should be enough to inform the unit conversion interface
33963423
# dates are coming in
@@ -3400,8 +3427,10 @@ def yaxis_date(self, tz=None):
34003427
"""
34013428
Sets up y-axis ticks and labels that treat the y data as dates.
34023429
3403-
*tz* is a timezone string or :class:`tzinfo` instance.
3404-
Defaults to rc value.
3430+
Parameters
3431+
----------
3432+
tz : string or :class:`tzinfo` instance, optional
3433+
Timezone string or timezone. Defaults to rc value.
34053434
"""
34063435
self.yaxis.axis_date(tz)
34073436

0 commit comments

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