aboutsummaryrefslogtreecommitdiff
path: root/docs/library/machine.Timer.rst
AgeCommit message (Collapse)Author
2020-10-20docs/library/machine.Timer.rst: Add mention of constructor arguments.Howard Lovatt
2020-08-21docs: Change `\*` to `*` in argument lists.Zenix27
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.
2018-07-31docs: Move WiPy specific Timer class to separate doc file.Damien George
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.
2017-04-18docs/library/machine.*: Add cross-reference label to individual classes.Damien George
2017-01-28docs/machine: Add explicit note on machine module level and scope.Paul Sokolovsky
It's very low, hardware level, with associated constraints on operations and callbacks.
2017-01-28docs/machine.Timer: Move WiPy adhoc parts to its documentation.Paul Sokolovsky
2016-08-02docs: Spelling mistakesMike Causer
2016-06-09docs/machine*: Remove explicit targets and "machine." prefixes on classes.Paul Sokolovsky
With currentmodule:: set properly, none are needed. Extra "machine." prefix produces wrong indexing data.
2016-06-08docs/machine.*: Use proper class case in method headers.Paul Sokolovsky
Class designator will be used as is in indexes, so must match actual class name.
2016-06-08docs/machine.*: Add "currentmodule:: machine" directive.Paul Sokolovsky
Makes sure that classes described in these separate files are properly designated as belonging to "machine" module in indexes.
2016-02-23docs: Correct machine.Timer code examples related to duty cycle.danicampora
2016-02-23docs: Add note on machine.Timer class regarding PWM output pins.danicampora
2016-02-22docs: Minor change to improve clarity in machine.Timer docs.danicampora
2016-02-21docs: Correct WiPy Timer docs.danicampora
2016-02-21cc3200: Simplify the Timer API and correct the documents.danicampora
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.
2015-10-21docs: Remove remaining references to 'af', which is now 'alt'.danicampora
2015-10-21docs: Several corrections to the classes in the machine module.danicampora
2015-10-17docs: Update all WiPy docs to reflect the new API.danicampora