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.
2016-06-08 16:21:28 +03:00
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.
2016-06-08 00:57:41 +03:00
b8133c4c0f
docs: Update pyb.I2C constructor to reflect changes in Pyboard Lite.
2016-03-17 20:18:36 +00:00
4542643025
docs: Update all WiPy docs to reflect the new API.
2015-10-17 23:29:04 +02:00
624cdeacc4
docs/wipy: Add pins to the I2C constructor.
2015-09-16 10:10:31 +02:00
f38d16483a
docs: Update I2C and UART docs to match the new API.
2015-09-16 10:10:22 +02:00
d43019163d
docs: Add i2c keywork arguments only indication.
2015-08-09 19:22:14 +02:00
c6926c374d
cc3200: Make I2C and SPI API the same as in stmhal.
2015-08-02 20:22:15 +02:00
cfcf47c064
docs: Add initial draft documentation for the WiPy.
...
This makes all common files "port-aware" using the .. only directive.
2015-06-10 23:37:56 +02:00
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
2014-11-15 18:31:37 +00:00
8e701604d5
docs: Add links from quickref to pyb classes.
2014-11-04 18:25:20 +00:00
a58713a899
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
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.
2014-10-31 01:37:19 +00:00
Paul Sokolovsky
Peter Hinch
danicampora
Matthias
Damien George