b1229efbd1
all: Fix spelling mistakes based on codespell check.
...
Signed-off-by: Damien George <damien@micropython.org>
2023-04-27 18:03:06 +10:00
7f6345a973
docs/library/machine.Timer: Add freq argument to machine.Timer.
...
Based on and tested on the rp2 port.
Signed-off-by: Liao Jingyi <liaojingyi2@gmail>
Signed-off-by: Damien George <damien@micropython.org>
2023-01-19 15:47:45 +11:00
68d1245f42
docs/library/machine.Timer.rst: Document `period` and `callback` args.
...
Signed-off-by: Michael Buesch <m@bues.ch>
2021-11-30 22:29:03 +11:00
e7900351bf
docs/library/machine.Timer.rst: Document 'id' as positional-only arg.
...
Signed-off-by: Michael Buesch <m@bues.ch>
2021-11-30 22:27:58 +11:00
31ac410a4f
docs: Fix some spelling mistakes.
2021-05-04 22:58:00 +10:00
4842060366
docs/library/machine.Timer.rst: Add mention of constructor arguments.
2020-10-20 17:23:54 +11:00
e76c7466b6
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 .
2020-08-21 12:24:13 +10:00
d8e0320485
docs: Move WiPy specific Timer class to separate doc file.
...
The WiPy machine.Timer class is very different to the esp8266 and esp32
implementations which are better candidates for a general Timer class. By
moving the WiPy Timer docs to a completely separate file, under a new name
machine.TimerWiPy, it gives a clean slate to define and write the docs for
a better, general machine.Timer class. This is with the aim of eventually
providing documentation that does not have conditional parts to it,
conditional on the port.
While the new docs are being defined it makes sense to keep the WiPy docs,
since they describe its behaviour. Once the new Timer behaviour is defined
the WiPy code can be changed to match it, and then the TimerWiPy docs would
be removed.
2018-07-31 23:40:06 +10:00
d4675e7674
docs/library/machine.*: Add cross-reference label to individual classes.
2017-04-18 15:27:37 +10:00
0aa83142a4
docs/machine: Add explicit note on machine module level and scope.
...
It's very low, hardware level, with associated constraints on operations
and callbacks.
2017-01-28 12:08:25 +03:00
56e7ebf07a
docs/machine.Timer: Move WiPy adhoc parts to its documentation.
2017-01-28 12:08:00 +03:00
ce166e6b68
docs: Spelling mistakes
2016-08-02 11:17:46 +03:00
79b40d1127
docs/machine*: Remove explicit targets and "machine." prefixes on classes.
...
With currentmodule:: set properly, none are needed. Extra "machine." prefix
produces wrong indexing data.
2016-06-09 03:03:53 +03:00
7d7243f44c
docs/machine.*: Use proper class case in method headers.
...
Class designator will be used as is in indexes, so must match actual class
name.
2016-06-08 01:33:49 +03:00
c8b7628094
docs/machine.*: Add "currentmodule:: machine" directive.
...
Makes sure that classes described in these separate files are properly
designated as belonging to "machine" module in indexes.
2016-06-08 00:46:27 +03:00
57b96a7be2
docs: Correct machine.Timer code examples related to duty cycle.
2016-02-23 20:22:26 +01:00
8e1fdf2eb3
docs: Add note on machine.Timer class regarding PWM output pins.
2016-02-23 19:53:59 +01:00
12547ce737
docs: Minor change to improve clarity in machine.Timer docs.
2016-02-22 19:16:30 +01:00
0d210a0be8
docs: Correct WiPy Timer docs.
2016-02-21 21:53:20 +01:00
73c9f85b4c
cc3200: Simplify the Timer API and correct the documents.
...
Make the PWM duty cycle configurable from 0.00 to 100.00 by
accepting values from 0 to 10000.
Add automatic Pin assignment when operating in PWM mode.
2016-02-21 21:53:16 +01:00
ee0058d174
docs: Remove remaining references to 'af', which is now 'alt'.
2015-10-21 15:30:57 +02:00
ceb169008d
docs: Several corrections to the classes in the machine module.
2015-10-21 15:30:56 +02:00
4542643025
docs: Update all WiPy docs to reflect the new API.
2015-10-17 23:29:04 +02:00
Damien George
LiaoJingyi_winY7kp
Michael Buesch
Mike Causer
Howard Lovatt
Zenix27
Damien George
Paul Sokolovsky
danicampora