Skip to content

Commit 8dfd67f

Browse files
committed
add const
1 parent f382012 commit 8dfd67f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/quick_start.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Plot Usage
55
=============
66
We start importing some fundamental libraries for plot to operate
77

8+
89
.. code-block:: python
910
1011
import board
@@ -117,15 +118,16 @@ The following snippet shows how to create a cartesian plot
117118
Tick spacing and numbers are selected by default. However it's possible to customize
118119
the following parameters:
119120

120-
.. py:function:: Plot.tick_params(tickx_height, ticky_height, tickcolor, tickgrid, showtext, decimal_points)
121+
.. py:function:: Plot.tick_params(showtick, tickx_height, ticky_height, tickcolor, tickgrid, showtext, decimal_points)
121122
122-
:parm bool showtick: displays the tick. Defaults to `True`
123+
:param bool showtick: displays the tick. Defaults to `True`
123124
:param int tickx_height: tickx_height in pixels
124125
:param int ticky_height: ticky_height in pixels
125126
:param int tickcolor: tickcolor in Hex format
126127
:param bool tickgrid: displays the tickgrid. Defaults to `False`
127128
:param bool showtext: displays the tick text. Defaults to `False`
128-
.. :param int decimal_points: number of decimal points to show. Defaults to `0`
129+
:param int decimal_points: number of decimal points to show. Defaults to :const:`0`
130+
129131

130132
.. code-block:: python
131133

0 commit comments

Comments
 (0)