@@ -2993,24 +2993,39 @@ def set_xticks(self, ticks, minor=False):
2993
2993
"""
2994
2994
Set the x ticks with list of *ticks*
2995
2995
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``.
2997
3004
"""
2998
3005
ret = self .xaxis .set_ticks (ticks , minor = minor )
2999
3006
self .stale = True
3000
3007
return ret
3001
3008
3002
3009
def get_xmajorticklabels (self ):
3003
3010
"""
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
3006
3017
"""
3007
3018
return cbook .silent_list ('Text xticklabel' ,
3008
3019
self .xaxis .get_majorticklabels ())
3009
3020
3010
3021
def get_xminorticklabels (self ):
3011
3022
"""
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
3014
3029
"""
3015
3030
return cbook .silent_list ('Text xticklabel' ,
3016
3031
self .xaxis .get_minorticklabels ())
@@ -3299,28 +3314,38 @@ def set_yticks(self, ticks, minor=False):
3299
3314
"""
3300
3315
Set the y ticks with list of *ticks*
3301
3316
3302
- ACCEPTS: sequence of floats
3303
-
3304
- Keyword arguments:
3317
+ Parameters
3318
+ ----------
3319
+ ticks : sequence
3320
+ List of y-axis tick locations
3305
3321
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``.
3308
3325
"""
3309
3326
ret = self .yaxis .set_ticks (ticks , minor = minor )
3310
3327
return ret
3311
3328
3312
3329
def get_ymajorticklabels (self ):
3313
3330
"""
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
3316
3337
"""
3317
3338
return cbook .silent_list ('Text yticklabel' ,
3318
3339
self .yaxis .get_majorticklabels ())
3319
3340
3320
3341
def get_yminorticklabels (self ):
3321
3342
"""
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
3324
3349
"""
3325
3350
return cbook .silent_list ('Text yticklabel' ,
3326
3351
self .yaxis .get_minorticklabels ())
@@ -3389,8 +3414,10 @@ def xaxis_date(self, tz=None):
3389
3414
"""
3390
3415
Sets up x-axis ticks and labels that treat the x data as dates.
3391
3416
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.
3394
3421
"""
3395
3422
# should be enough to inform the unit conversion interface
3396
3423
# dates are coming in
@@ -3400,8 +3427,10 @@ def yaxis_date(self, tz=None):
3400
3427
"""
3401
3428
Sets up y-axis ticks and labels that treat the y data as dates.
3402
3429
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.
3405
3434
"""
3406
3435
self .yaxis .axis_date (tz )
3407
3436
0 commit comments