aboutsummaryrefslogtreecommitdiff
path: root/docs/library/machine.UART.rst
AgeCommit message (Collapse)Author
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.
2020-01-06docs/library/machine.UART.rst: Detail timeout behaviour of read methods.Jason Neal
Also document existence of "invert" argument to constructor.
2018-08-14docs/library/machine.UART.rst: Specify optional txbuf and rxbuf args.Damien George
If a port would like to expose the configuration of transmit and/or receive buffers then it can use these arguments.
2018-07-18docs/library/machine.UART: Remove conditional docs for wipy port.Damien George
The UART.init() method is now included unconditionally and its wording adjusted to better describe ports other than the cc3200. UART.irq() is also included unconditionally, but this is currently only available on the WiPy target.
2017-12-04docs/library: Add xrefs to "stream" dictionary entry for many modules.Paul Sokolovsky
2017-06-25docs/machine*: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-05-29various: Spelling fixesVille Skyttä
2017-05-19docs/library/machine.UART: Update and improve uart.any() docs.Damien George
2017-04-18docs/library/machine.*: Add cross-reference label to individual classes.Damien George
2017-04-18docs/library/machine.UART: Remove pyboard-specific section.Damien George
stmhal doesn't have a machine.UART class so this section is not needed.
2017-04-16docs/machine.UART: Deconditionalize normal methods.Paul Sokolovsky
2017-04-09docs/library/machine.UART: Remove some conditionals.Paul Sokolovsky
2016-11-14docs: Remove references to readall() and update stream read() docs.Damien George
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.UART: Cleanup pyboard section.Paul Sokolovsky
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-05-07docs/machine.UART: Filter out unimplemented UART methods from esp8266 docs.Radomir Dopieralski
2015-10-25docs: Explicitly specify behavior of UART stream protocol methods on timeout.Paul Sokolovsky
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