aboutsummaryrefslogtreecommitdiff
path: root/docs/library/machine.Timer.rst
diff options
context:
space:
mode:
authorMichael Buesch <m@bues.ch>2020-08-31 17:12:38 +0200
committerDamien George <damien@micropython.org>2021-11-30 22:27:58 +1100
commite7900351bf954f5af939981d5c6c978636073950 (patch)
tree14922acfbc5140fffcd03acbd438855a92bef1e8 /docs/library/machine.Timer.rst
parentd94ac4333ff87e8a1b28ae3b10b1ef0c6de9cfb0 (diff)
docs/library/machine.Timer.rst: Document 'id' as positional-only arg.
Signed-off-by: Michael Buesch <m@bues.ch>
Diffstat (limited to 'docs/library/machine.Timer.rst')
-rw-r--r--docs/library/machine.Timer.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/library/machine.Timer.rst b/docs/library/machine.Timer.rst
index 77a549b40..d1709a818 100644
--- a/docs/library/machine.Timer.rst
+++ b/docs/library/machine.Timer.rst
@@ -27,11 +27,12 @@ instead of this class.
Constructors
------------
-.. class:: Timer(id, ...)
+.. class:: Timer(id, /, ...)
- Construct a new timer object of the given id. Id of -1 constructs a
+ Construct a new timer object of the given ``id``. ``id`` of -1 constructs a
virtual timer (if supported by a board).
-
+ ``id`` shall not be passed as a keyword argument.
+
See ``init`` for parameters of initialisation.
Methods