@@ -2918,17 +2918,29 @@ def get_xscale(self):
29182918 get_xscale .__doc__ = "Return the xaxis scale string: %s" "" % (
29192919 ", " .join (mscale .get_scale_names ()))
29202920
2921- @docstring .dedent_interpd
29222921 def set_xscale (self , value , ** kwargs ):
29232922 """
29242923 Set the x-axis scale
29252924
29262925 Parameters
29272926 ----------
2928- value: float
2929- Value to scale x-axis by
2927+ value : ["linear", "log", "symlog", "logit"]
2928+ scaling strategy to apply
2929+
2930+ Notes
2931+ -----
2932+ Different kwargs are accepted, depending on the scale. See
2933+ the `~matplotlib.scale` module for more information.
2934+
2935+ See also
2936+ --------
2937+ matplotlib.scale.LinearScale : linear transfrom
2938+
2939+ matplotlib.scale.LogTransform : log transform
29302940
2931- Different kwargs are accepted, depending on the scale
2941+ matplotlib.scale.SymmetricalLogTransform : symlog transform
2942+
2943+ matplotlib.scale.LogisticTransform : logit transform
29322944 """
29332945 # If the scale is being set to log, clip nonposx to prevent headaches
29342946 # around zero
@@ -2998,24 +3010,22 @@ def get_xticklabels(self, minor=False, which=None):
29983010 self .xaxis .get_ticklabels (minor = minor ,
29993011 which = which ))
30003012
3001- @docstring .dedent_interpd
30023013 def set_xticklabels (self , labels , fontdict = None , minor = False , ** kwargs ):
30033014 """
3004- Set the xtick labels with list of strings labels
3015+ Set the xtick labels with list of string labels
30053016
30063017 Parameters
30073018 ----------
3008- labels: list of str
3019+ labels : list of str
30093020 list of string labels
30103021
30113022 Returns
30123023 -------
3013- list of str
3014- A list of axis text instances
3024+ A list of `~matplotlib.text.Text` instances
30153025
30163026 Other Parameters
30173027 -----------------
3018- kwargs : :class: `~matplotlib.text.Text` properties.
3028+ ** kwargs : `~matplotlib.text.Text` properties.
30193029 """
30203030 if fontdict is not None :
30213031 kwargs .update (fontdict )
@@ -3204,20 +3214,29 @@ def get_yscale(self):
32043214 get_yscale .__doc__ = "Return the yaxis scale string: %s" "" % (
32053215 ", " .join (mscale .get_scale_names ()))
32063216
3207- @docstring .dedent_interpd
32083217 def set_yscale (self , value , ** kwargs ):
32093218 """
32103219 Set the y-axis scale
32113220
32123221 Parameters
32133222 ----------
3214- value: float
3215- Value to scale y-axis by
3223+ value : ["linear", "log", "symlog", "logit"]
3224+ scaling strategy to apply
32163225
3217- Other Parameters
3218- -----------------
3219- kwargs : :class:`~matplotlib.text.Text` properties.
3226+ Notes
3227+ -----
3228+ Different kwargs are accepted, depending on the scale. See
3229+ the `~matplotlib.scale` module for more information.
3230+
3231+ See also
3232+ --------
3233+ matplotlib.scale.LinearScale : linear transfrom
3234+
3235+ matplotlib.scale.LogTransform : log transform
3236+
3237+ matplotlib.scale.SymmetricalLogTransform : symlog transform
32203238
3239+ matplotlib.scale.LogisticTransform : logit transform
32213240 """
32223241 # If the scale is being set to log, clip nonposy to prevent headaches
32233242 # around zero
@@ -3290,25 +3309,22 @@ def get_yticklabels(self, minor=False, which=None):
32903309 self .yaxis .get_ticklabels (minor = minor ,
32913310 which = which ))
32923311
3293- @docstring .dedent_interpd
32943312 def set_yticklabels (self , labels , fontdict = None , minor = False , ** kwargs ):
32953313 """
32963314 Set the xtick labels with list of strings labels
32973315
32983316 Parameters
32993317 ----------
3300- labels: list of str
3318+ labels : list of str
33013319 list of string labels
33023320
33033321 Returns
33043322 -------
3305- list of str
3306- A list of :class:`~matplotlib.text.Text` instances.
3323+ A list of `~matplotlib.text.Text` instances.
33073324
33083325 Other Parameters
33093326 ----------------
3310- *kwargs* set the :class:`~matplotlib.text.Text` properties.
3311-
3327+ **kwargs : `~matplotlib.text.Text` properties.
33123328 """
33133329 if fontdict is not None :
33143330 kwargs .update (fontdict )
@@ -3888,17 +3904,19 @@ def twinx(self):
38883904 """
38893905 Create a twin Axes sharing the xaxis
38903906
3891- Create a twin of Axes for generating a plot with a sharex
3892- x-axis but independent y axis. The y-axis of self will have
3907+ Create a twin of Axes for generating a plot with a shared
3908+ x-axis but independent y- axis. The y-axis of self will have
38933909 ticks on left and the returned axes will have ticks on the
38943910 right. To ensure tick marks of both axis align, see
3895- :class: `~matplotlib.ticker.LinearLocator`
3911+ `~matplotlib.ticker.LinearLocator`
38963912
38973913 Returns
38983914 -------
38993915 Axis
39003916 The newly created axis
39013917
3918+ Notes
3919+ -----
39023920 For those who are 'picking' artists while using twinx, pick
39033921 events are only called for the artists in the top-most axes.
39043922 """
@@ -3916,7 +3934,7 @@ def twiny(self):
39163934 Create a twin Axes sharing the yaxis
39173935
39183936 Create a twin of Axes for generating a plot with a shared
3919- y-axis but independent x axis. The x-axis of self will have
3937+ y-axis but independent x- axis. The x-axis of self will have
39203938 ticks on bottom and the returned axes will have ticks on the
39213939 top.
39223940
@@ -3925,6 +3943,8 @@ def twiny(self):
39253943 Axis
39263944 The newly created axis
39273945
3946+ Notes
3947+ ------
39283948 For those who are 'picking' artists while using twiny, pick
39293949 events are only called for the artists in the top-most axes.
39303950 """
0 commit comments