Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 650b640

Browse files
committed
DOC: numpydocify Axes.tick_params
1 parent 9925fc2 commit 650b640

1 file changed

Lines changed: 27 additions & 19 deletions

File tree

lib/matplotlib/axes/_base.py

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2617,58 +2617,66 @@ def locator_params(self, axis='both', tight=None, **kwargs):
26172617
self.autoscale_view(tight=tight, scalex=_x, scaley=_y)
26182618

26192619
def tick_params(self, axis='both', **kwargs):
2620-
"""
2621-
Change the appearance of ticks and tick labels.
2620+
"""Change the appearance of ticks and tick labels.
26222621
2623-
Keyword arguments:
2622+
Parameters
2623+
----------
2624+
axis : {'x', 'y', 'both'}, optional
2625+
Which axis to apply the parameters to.
26242626
2625-
*axis* : ['x' | 'y' | 'both']
2627+
Other Parameters
2628+
----------------
2629+
2630+
axis : {'x', 'y', 'both'}
26262631
Axis on which to operate; default is 'both'.
26272632
2628-
*reset* : [True | False]
2633+
reset : bool
26292634
If *True*, set all parameters to defaults
26302635
before processing other keyword arguments. Default is
26312636
*False*.
26322637
2633-
*which* : ['major' | 'minor' | 'both']
2638+
which : {'major', 'minor', 'both'}
26342639
Default is 'major'; apply arguments to *which* ticks.
26352640
2636-
*direction* : ['in' | 'out' | 'inout']
2641+
direction : {'in', 'out', 'inout'}
26372642
Puts ticks inside the axes, outside the axes, or both.
26382643
2639-
*length*
2644+
length : float
26402645
Tick length in points.
26412646
2642-
*width*
2647+
width : float
26432648
Tick width in points.
26442649
2645-
*color*
2650+
color : color
26462651
Tick color; accepts any mpl color spec.
26472652
2648-
*pad*
2653+
pad : float
26492654
Distance in points between tick and label.
26502655
2651-
*labelsize*
2656+
labelsize : float or str
26522657
Tick label font size in points or as a string (e.g., 'large').
26532658
2654-
*labelcolor*
2659+
labelcolor : color
26552660
Tick label color; mpl color spec.
26562661
2657-
*colors*
2662+
colors : color
26582663
Changes the tick color and the label color to the same value:
26592664
mpl color spec.
26602665
2661-
*zorder*
2666+
zorder : float
26622667
Tick and label zorder.
26632668
2664-
*bottom*, *top*, *left*, *right* : [bool | 'on' | 'off']
2669+
bottom, top, left, right : bool or {'on', 'off'}
26652670
controls whether to draw the respective ticks.
26662671
2667-
*labelbottom*, *labeltop*, *labelleft*, *labelright*
2668-
Boolean or ['on' | 'off'], controls whether to draw the
2672+
labelbottom, labeltop, labelleft, labelright : bool or {'on', 'off'}
2673+
controls whether to draw the
26692674
respective tick labels.
26702675
2671-
Example::
2676+
Examples
2677+
--------
2678+
2679+
Usage ::
26722680
26732681
ax.tick_params(direction='out', length=6, width=2, colors='r')
26742682

0 commit comments

Comments
 (0)