summaryrefslogtreecommitdiff
path: root/docs/library/pyb.Timer.rst
diff options
context:
space:
mode:
authorZenix27 <30363000+Zenix27@users.noreply.github.com>2020-07-11 12:23:26 +0530
committerDamien George <damien@micropython.org>2020-08-21 12:24:13 +1000
commite76c7466b62c940150cf1b5000e18f60a5efa2e3 (patch)
tree0ced7b7a5eb3f5efb6524ca1cf65bd0188b57bc5 /docs/library/pyb.Timer.rst
parent17689a71f66bcf96c09f8700fa3e0f5aa5be225c (diff)
docs: Change `\*` to `*` in argument lists.
Latest versions of Sphinx (at least 3.1.0) do not need the `*` escaped and will render the `\` in the output if it is there, so remove it. Fixes issue #6209.
Diffstat (limited to 'docs/library/pyb.Timer.rst')
-rw-r--r--docs/library/pyb.Timer.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/library/pyb.Timer.rst b/docs/library/pyb.Timer.rst
index 532b64da8..34fe71155 100644
--- a/docs/library/pyb.Timer.rst
+++ b/docs/library/pyb.Timer.rst
@@ -62,7 +62,7 @@ Constructors
Methods
-------
-.. method:: Timer.init(\*, freq, prescaler, period, mode=Timer.UP, div=1, callback=None, deadtime=0)
+.. method:: Timer.init(*, freq, prescaler, period, mode=Timer.UP, div=1, callback=None, deadtime=0)
Initialise the timer. Initialisation must be either by frequency (in Hz)
or by prescaler and period::