diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py index eeadfc87a1e0..24c2d48f9871 100644 --- a/lib/matplotlib/axes/_base.py +++ b/lib/matplotlib/axes/_base.py @@ -2993,7 +2993,14 @@ def set_xticks(self, ticks, minor=False): """ Set the x ticks with list of *ticks* - ACCEPTS: sequence of floats + Parameters + ---------- + ticks : list + List of x-axis tick locations + + minor : bool, optional + If ``False`` sets major ticks, if ``True`` sets minor ticks. + Default is ``False``. """ ret = self.xaxis.set_ticks(ticks, minor=minor) self.stale = True @@ -3001,16 +3008,24 @@ def set_xticks(self, ticks, minor=False): def get_xmajorticklabels(self): """ - Get the xtick labels as a list of :class:`~matplotlib.text.Text` - instances. + Get the xtick major labels + + Returns + ------- + labels : list + List of :class:`~matplotlib.text.Text` instances """ return cbook.silent_list('Text xticklabel', self.xaxis.get_majorticklabels()) def get_xminorticklabels(self): """ - Get the x minor tick labels as a list of - :class:`matplotlib.text.Text` instances. + Get the x minor tick labels + + Returns + ------- + labels : list + List of :class:`~matplotlib.text.Text` instances """ return cbook.silent_list('Text xticklabel', self.xaxis.get_minorticklabels()) @@ -3299,28 +3314,38 @@ def set_yticks(self, ticks, minor=False): """ Set the y ticks with list of *ticks* - ACCEPTS: sequence of floats - - Keyword arguments: + Parameters + ---------- + ticks : sequence + List of y-axis tick locations - *minor*: [ *False* | *True* ] - Sets the minor ticks if *True* + minor : bool, optional + If ``False`` sets major ticks, if ``True`` sets minor ticks. + Default is ``False``. """ ret = self.yaxis.set_ticks(ticks, minor=minor) return ret def get_ymajorticklabels(self): """ - Get the major y tick labels as a list of - :class:`~matplotlib.text.Text` instances. + Get the major y tick labels + + Returns + ------- + labels : list + List of :class:`~matplotlib.text.Text` instances """ return cbook.silent_list('Text yticklabel', self.yaxis.get_majorticklabels()) def get_yminorticklabels(self): """ - Get the minor y tick labels as a list of - :class:`~matplotlib.text.Text` instances. + Get the minor y tick labels + + Returns + ------- + labels : list + List of :class:`~matplotlib.text.Text` instances """ return cbook.silent_list('Text yticklabel', self.yaxis.get_minorticklabels()) @@ -3389,8 +3414,10 @@ def xaxis_date(self, tz=None): """ Sets up x-axis ticks and labels that treat the x data as dates. - *tz* is a timezone string or :class:`tzinfo` instance. - Defaults to rc value. + Parameters + ---------- + tz : string or :class:`tzinfo` instance, optional + Timezone string or timezone. Defaults to rc value. """ # should be enough to inform the unit conversion interface # dates are coming in @@ -3400,8 +3427,10 @@ def yaxis_date(self, tz=None): """ Sets up y-axis ticks and labels that treat the y data as dates. - *tz* is a timezone string or :class:`tzinfo` instance. - Defaults to rc value. + Parameters + ---------- + tz : string or :class:`tzinfo` instance, optional + Timezone string or timezone. Defaults to rc value. """ self.yaxis.axis_date(tz)