@@ -2927,17 +2927,29 @@ def get_xscale(self):
2927
2927
get_xscale .__doc__ = "Return the xaxis scale string: %s" "" % (
2928
2928
", " .join (mscale .get_scale_names ()))
2929
2929
2930
- @docstring .dedent_interpd
2931
2930
def set_xscale (self , value , ** kwargs ):
2932
2931
"""
2933
2932
Set the x-axis scale
2934
2933
2935
2934
Parameters
2936
2935
----------
2937
- value: float
2938
- Value to scale x-axis by
2936
+ value : ["linear", "log", "symlog", "logit"]
2937
+ scaling strategy to apply
2938
+
2939
+ Notes
2940
+ -----
2941
+ Different kwargs are accepted, depending on the scale. See
2942
+ the `~matplotlib.scale` module for more information.
2943
+
2944
+ See also
2945
+ --------
2946
+ matplotlib.scale.LinearScale : linear transfrom
2947
+
2948
+ matplotlib.scale.LogTransform : log transform
2939
2949
2940
- Different kwargs are accepted, depending on the scale
2950
+ matplotlib.scale.SymmetricalLogTransform : symlog transform
2951
+
2952
+ matplotlib.scale.LogisticTransform : logit transform
2941
2953
"""
2942
2954
# If the scale is being set to log, clip nonposx to prevent headaches
2943
2955
# around zero
@@ -3007,24 +3019,22 @@ def get_xticklabels(self, minor=False, which=None):
3007
3019
self .xaxis .get_ticklabels (minor = minor ,
3008
3020
which = which ))
3009
3021
3010
- @docstring .dedent_interpd
3011
3022
def set_xticklabels (self , labels , fontdict = None , minor = False , ** kwargs ):
3012
3023
"""
3013
- Set the xtick labels with list of strings labels
3024
+ Set the xtick labels with list of string labels
3014
3025
3015
3026
Parameters
3016
3027
----------
3017
- labels: list of str
3028
+ labels : list of str
3018
3029
list of string labels
3019
3030
3020
3031
Returns
3021
3032
-------
3022
- list of str
3023
- A list of axis text instances
3033
+ A list of `~matplotlib.text.Text` instances
3024
3034
3025
3035
Other Parameters
3026
3036
-----------------
3027
- kwargs : :class: `~matplotlib.text.Text` properties.
3037
+ kwargs : `~matplotlib.text.Text` properties.
3028
3038
"""
3029
3039
if fontdict is not None :
3030
3040
kwargs .update (fontdict )
@@ -3214,19 +3224,29 @@ def get_yscale(self):
3214
3224
get_yscale .__doc__ = "Return the yaxis scale string: %s" "" % (
3215
3225
", " .join (mscale .get_scale_names ()))
3216
3226
3217
- @docstring .dedent_interpd
3218
3227
def set_yscale (self , value , ** kwargs ):
3219
3228
"""
3220
3229
Set the y-axis scale
3221
3230
3222
3231
Parameters
3223
3232
----------
3224
- value: float
3225
- Value to scale y-axis by
3233
+ value : ["linear", "log", "symlog", "logit"]
3234
+ scaling strategy to apply
3235
+
3236
+ Notes
3237
+ -----
3238
+ Different kwargs are accepted, depending on the scale. See
3239
+ the `~matplotlib.scale` module for more information.
3226
3240
3227
- Other Parameters
3228
- -----------------
3229
- kwargs : :class:`~matplotlib.text.Text` properties.
3241
+ See also
3242
+ --------
3243
+ matplotlib.scale.LinearScale : linear transfrom
3244
+
3245
+ matplotlib.scale.LogTransform : log transform
3246
+
3247
+ matplotlib.scale.SymmetricalLogTransform : symlog transform
3248
+
3249
+ matplotlib.scale.LogisticTransform : logit transform
3230
3250
3231
3251
"""
3232
3252
# If the scale is being set to log, clip nonposy to prevent headaches
@@ -3300,24 +3320,22 @@ def get_yticklabels(self, minor=False, which=None):
3300
3320
self .yaxis .get_ticklabels (minor = minor ,
3301
3321
which = which ))
3302
3322
3303
- @docstring .dedent_interpd
3304
3323
def set_yticklabels (self , labels , fontdict = None , minor = False , ** kwargs ):
3305
3324
"""
3306
3325
Set the xtick labels with list of strings labels
3307
3326
3308
3327
Parameters
3309
3328
----------
3310
- labels: list of str
3329
+ labels : list of str
3311
3330
list of string labels
3312
3331
3313
3332
Returns
3314
3333
-------
3315
- list of str
3316
- A list of :class:`~matplotlib.text.Text` instances.
3334
+ A list of `~matplotlib.text.Text` instances.
3317
3335
3318
3336
Other Parameters
3319
3337
----------------
3320
- * kwargs* set the :class: `~matplotlib.text.Text` properties.
3338
+ kwargs : `~matplotlib.text.Text` properties.
3321
3339
3322
3340
"""
3323
3341
if fontdict is not None :
@@ -3898,17 +3916,19 @@ def twinx(self):
3898
3916
"""
3899
3917
Create a twin Axes sharing the xaxis
3900
3918
3901
- Create a twin of Axes for generating a plot with a sharex
3902
- x-axis but independent y axis. The y-axis of self will have
3919
+ Create a twin of Axes for generating a plot with a shared
3920
+ x-axis but independent y- axis. The y-axis of self will have
3903
3921
ticks on left and the returned axes will have ticks on the
3904
3922
right. To ensure tick marks of both axis align, see
3905
- :class: `~matplotlib.ticker.LinearLocator`
3923
+ `~matplotlib.ticker.LinearLocator`
3906
3924
3907
3925
Returns
3908
3926
-------
3909
3927
Axis
3910
3928
The newly created axis
3911
3929
3930
+ Notes
3931
+ -----
3912
3932
For those who are 'picking' artists while using twinx, pick
3913
3933
events are only called for the artists in the top-most axes.
3914
3934
"""
@@ -3926,7 +3946,7 @@ def twiny(self):
3926
3946
Create a twin Axes sharing the yaxis
3927
3947
3928
3948
Create a twin of Axes for generating a plot with a shared
3929
- y-axis but independent x axis. The x-axis of self will have
3949
+ y-axis but independent x- axis. The x-axis of self will have
3930
3950
ticks on bottom and the returned axes will have ticks on the
3931
3951
top.
3932
3952
@@ -3935,6 +3955,8 @@ def twiny(self):
3935
3955
Axis
3936
3956
The newly created axis
3937
3957
3958
+ Notes
3959
+ ------
3938
3960
For those who are 'picking' artists while using twiny, pick
3939
3961
events are only called for the artists in the top-most axes.
3940
3962
"""
0 commit comments