Damien George
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
Jos Verlinde
7621b17636
docs/library/machine.SPI.rst: Add class constant SoftSPI.MSB and .LSB.
2022-02-09 15:05:38 +11:00
Michael Buesch
1e7c8f2b0b
docs/library/machine.SPI.rst: Add example SPI usage.
...
Signed-off-by: Michael Buesch <m@bues.ch>
2021-11-30 22:28:19 +11:00
David P
fdd5b18133
docs: Replace master/slave with controller/peripheral in I2C and SPI.
...
See https://www.oshwa.org/a-resolution-to-redefine-spi-signal-names
2021-07-18 11:19:44 +10:00
Damien George
98182a97c5
docs: Update I2C and SPI docs to add reference to SoftI2C and SoftSPI.
...
Signed-off-by: Damien George <damien@micropython.org>
2020-10-01 12:57:10 +10:00
Zenix27
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
Peter Hinch
09c5c58a1f
docs/library/machine.SPI: Add note about baudrate imprecision.
2018-09-26 15:21:10 +10:00
Damien George
29b26f3922
docs/library/machine.SPI: Fix formatting of bullet list to stop warning.
2017-04-18 15:40:04 +10:00
Damien George
d4675e7674
docs/library/machine.*: Add cross-reference label to individual classes.
2017-04-18 15:27:37 +10:00
Paul Sokolovsky
4333b2fb53
docs/machine.SPI: Remove outdated wipy chunk.
2017-04-05 11:47:15 +03:00
Mike Causer
a79f6676c3
docs: Fix some minor spelling mistakes.
...
paramter -> parameter
send a receive -> send and receive
repsonse -> response
particualr -> particular
constructore -> constructor
2017-01-18 15:30:31 +11:00
Paul Sokolovsky
67c91df7e8
docs/machine.SPI.rst: Fix typos and formatting, clarify.
...
Clarify the class implements master side of the protocol, also put adhoc
WiPy paramter after the generic, described in the current Hardware API
version.
2016-10-25 17:03:35 +03:00
Damien George
266e4acdc2
docs/library/machine.SPI: Remove spurious "of".
2016-10-24 14:41:21 +11:00
Damien George
f12047f66d
docs/machine.SPI: Improve descriptions of xfer methods.
...
In particular remove the "*" because not all ports support keyword
arguments.
2016-10-18 10:14:26 +11:00
Paul Sokolovsky
a0b2f48c2f
docs/machine.SPI: Bring up to date with Hardware API, make vendor-neutral.
2016-10-17 18:05:16 +03:00
Mike Causer
ce166e6b68
docs: Spelling mistakes
2016-08-02 11:17:46 +03:00
Paul Sokolovsky
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
Paul Sokolovsky
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
Paul Sokolovsky
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
danicampora
4542643025
docs: Update all WiPy docs to reflect the new API.
2015-10-17 23:29:04 +02:00