a384a53130
docs/pyb.*: 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
0a4cc24b2e
docs/pyb.*: Add "currentmodule:: pyb" directive.
Makes sure that classes described in these separate files are properly
designated as belonging to "pyb" module in indexes.
9 years ago
b8133c4c0f
docs: Update pyb.I2C constructor to reflect changes in Pyboard Lite.
9 years ago
4542643025
docs: Update all WiPy docs to reflect the new API.
9 years ago
624cdeacc4
docs/wipy: Add pins to the I2C constructor.
9 years ago
f38d16483a
docs: Update I2C and UART docs to match the new API.
9 years ago
d43019163d
docs: Add i2c keywork arguments only indication.
9 years ago
c6926c374d
cc3200: Make I2C and SPI API the same as in stmhal.
9 years ago
cfcf47c064
docs: Add initial draft documentation for the WiPy.
This makes all common files "port-aware" using the .. only directive.
10 years ago
ca0b0cb83f
Document parameter "data" of i2c.mem_read() more clear
Hi,
i would like to add a little clarification to the parameter "data" of i2c.mem_read(): I misunderstood
``data`` can be an integer or a buffer to read into
as "i can give a integer variable to read a integer into" . This pull-request adds the following clarification:
``data`` can be an integer (number of bytes to read) or a buffer to read into
Thanks for your great work!
Best wishes,
Matthias
10 years ago
8e701604d5
docs: Add links from quickref to pyb classes.
10 years ago
a58713a899
docs: Cleanup and update some docs.
10 years ago
88d3054ac0
docs: Import documentation from source-code inline comments.
The inline docs (prefixed with /// in .c files) have been converted to
RST format and put in the docs subdirectory.
10 years ago
Paul Sokolovsky
Peter Hinch
danicampora
Matthias
Damien George