djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/library/machine.Timer.rst: Document 'id' as positional-only arg.

Browse Source 
Signed-off-by: Michael Buesch <m@bues.ch>
This commit is contained in:
Michael Buesch 2020-08-31 17:12:38 +02:00 committed by Damien George
parent d94ac4333f
commit e7900351bf
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/library/machine.Timer.rst
View File

@ -27,10 +27,11 @@ 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.