b1229efbd1
all: Fix spelling mistakes based on codespell check.
Signed-off-by: Damien George <damien@micropython.org>
2 years ago
7621b17636
docs/library/machine.SPI.rst: Add class constant SoftSPI.MSB and .LSB.
3 years ago
1e7c8f2b0b
docs/library/machine.SPI.rst: Add example SPI usage.
Signed-off-by: Michael Buesch <m@bues.ch>
4 years ago
fdd5b18133
docs: Replace master/slave with controller/peripheral in I2C and SPI.
See https://www.oshwa.org/a-resolution-to-redefine-spi-signal-names
3 years ago
98182a97c5
docs: Update I2C and SPI docs to add reference to SoftI2C and SoftSPI.
Signed-off-by: Damien George <damien@micropython.org>
4 years ago
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 .
4 years ago
09c5c58a1f
docs/library/machine.SPI: Add note about baudrate imprecision.
6 years ago
29b26f3922
docs/library/machine.SPI: Fix formatting of bullet list to stop warning.
8 years ago
d4675e7674
docs/library/machine.*: Add cross-reference label to individual classes.
8 years ago
4333b2fb53
docs/machine.SPI: Remove outdated wipy chunk.
8 years ago
a79f6676c3
docs: Fix some minor spelling mistakes.
paramter -> parameter
send a receive -> send and receive
repsonse -> response
particualr -> particular
constructore -> constructor
8 years ago
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.
8 years ago
266e4acdc2
docs/library/machine.SPI: Remove spurious "of".
8 years ago
f12047f66d
docs/machine.SPI: Improve descriptions of xfer methods.
In particular remove the "*" because not all ports support keyword
arguments.
8 years ago
a0b2f48c2f
docs/machine.SPI: Bring up to date with Hardware API, make vendor-neutral.
8 years ago
ce166e6b68
docs: Spelling mistakes
8 years ago
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.
9 years ago
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.
9 years ago
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.
9 years ago
4542643025
docs: Update all WiPy docs to reflect the new API.
9 years ago
Damien George
Jos Verlinde
Michael Buesch
David P
Zenix27
Peter Hinch
Damien George
Paul Sokolovsky
Mike Causer
danicampora