3e5e4f95b2
docs/library/machine.Pin: Update Pin docs to align with new HW API.
2016-11-09 11:08:01 +11:00
805f7ea2f2
docs/utime: Add docs for ticks_add(), improvements for other ticks_*().
2016-11-01 00:14:12 +03:00
8679d9e6a6
docs/utime: Remove only:: for ticks_diff().
...
It's mandatory function which should be present in every port. Even if
it's not, in the stdlib intro we waarn users that a particular port can
lack anything of described in the docs.
2016-11-01 00:03:40 +03:00
d60ad5cf53
docs/utime: Describe new semantics of ticks_diff() (signed ring arithmetics).
2016-10-31 00:17:56 +03:00
153665f159
docs/utime: Document ticks_cpu() in more detail.
...
Also, drop ::only directive.
2016-10-30 23:15:28 +03:00
7219a18d17
docs/library/index: Update TOCs so builtins sorted before modules.
2016-10-30 23:13:52 +03:00
c28f9df63a
docs/library/network: Typo fixes, consistent acronym capitalization.
2016-10-28 12:03:35 +03:00
b9a88683a4
docs/library/network: Reword intro paragraph.
2016-10-28 04:42:27 +03:00
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
f1b2b1b600
docs/library/builtins: Add docs for delattr and slice.
2016-10-25 11:02:47 +11:00
266e4acdc2
docs/library/machine.SPI: Remove spurious "of".
2016-10-24 14:41:21 +11:00
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
a0b2f48c2f
docs/machine.SPI: Bring up to date with Hardware API, make vendor-neutral.
2016-10-17 18:05:16 +03:00
00c1fc6d77
docs/uos: Add uos.statvfs() documentation.
2016-10-07 13:16:54 +11:00
eb239b8398
stmhal/usb: Add support to receive USB HID messages from host.
2016-10-04 15:38:01 +11:00
219245e10f
extmod/machine_i2c: Add support for the addrsize parameter in mem xfers.
...
The memory read/write I2C functions now take an optional keyword-only
parameter that specifies the number of bits in the memory address.
Only mem-addrs that are a multiple of 8-bits are supported (otherwise
the behaviour is undefined).
Due to the integer type used for the address, for values larger than 32
bits, only 32 bits of address will be sent, and the rest will be padded
with 0s. Right now no exception is raised when that happens. For values
smaller than 8, no address is sent. Also no exception then.
Tested with a VL6180 sensor, which has 16-bit register addresses.
Due to code refactoring, this patch reduces stmhal and esp8266 builds
by about 50 bytes.
2016-09-28 14:45:29 +10:00
eeb9d99333
docs/library/machine: Update description of disable/enable IRQ funcs.
2016-09-23 13:15:58 +10:00
4ab3eef8d7
docs/library/pyb.SPI: init(): Describe "bits" argument.
...
Based on https://github.com/micropython/micropython/pull/2210 .
2016-09-18 21:41:21 +03:00
f3b5480be7
stmhal,cc3200,esp8266: Consistently use PWRON_RESET constant.
...
machine.POWER_ON is renamed to machine.PWRON_RESET to match other
reset-cause constants that all end in _RESET. The cc3200 port keeps a
legacy definition of POWER_ON for backwards compatibility.
2016-09-08 12:50:38 +10:00
4a9542c0c0
docs/library/machine.WDT: Add that WDT is available on pyboard.
2016-09-06 14:20:52 +10:00
0f8b1ba8a2
docs/library: Add reference for pyb.usb_mode and pyb.USB_HID.
2016-08-29 15:17:20 +10:00
64c5a9435c
docs/library/machine.WDT: Add note that WDT is only available on WiPy.
2016-08-17 14:22:39 +10:00
5c73de0337
docs/uio: Mention seek()/flush() support for io.BytesIO.
2016-08-09 01:52:56 +03:00
fdb411a8c5
docs/library/index: Include array module in ToC.
2016-08-07 00:16:41 +03:00
8a0b6f561c
docs/array: Document array module.
2016-08-07 00:13:48 +03:00
ce166e6b68
docs: Spelling mistakes
2016-08-02 11:17:46 +03:00
047ac2044d
docs/library: Fix typo in docs for usocket.listen().
2016-06-26 12:38:20 +01:00
2b6dcdd3e4
docs/sys: print_exception: Fixes/clarifications.
2016-06-18 19:06:53 +03:00
617e033e2f
docs/select: Add an article.
2016-06-18 19:06:42 +03:00
9de5eb278d
docs/sys: Detailed description of print_exception() diff from traceback module.
2016-06-10 23:06:56 +03:00
343b5c1081
docs/uctypes: Improve documentation.
...
Seealso and Limitations sectiosn added, better formatting and grammar.
2016-06-09 05:02:55 +03:00
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
a0c296f6d5
docs/machine.Pin: Disambiguate object call method.
2016-06-09 02:58:15 +03:00
1d3b903eb5
docs/library/index: Add builtins.rst.
2016-06-09 00:26:44 +03:00
0cec4e9bb8
docs/builtins: Enumerate all builtin functions implemented.
...
Based on unix version. No descriptions so far.
2016-06-09 00:24:52 +03:00
f1eb672d88
docs/pyb.Pin: Sort .af() and .af_list() methods together.
2016-06-08 16:36:22 +03:00
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
585aafc27e
docs/pyb.ExtInt,pyb.Pin: Mark up class methods as such.
2016-06-08 16:00:12 +03:00
0d8c22b122
docs/pyb.Pin: af_list() is a normal method, not a class method.
2016-06-08 15:57:46 +03:00
8171995ee9
docs/pyb.CAN: Mark CAN.initfilterbanks() as classmethod explicitly.
2016-06-08 15:49:30 +03:00
bba77a2d01
docs/machine.Pin: Add class designator to all constants.
...
This makes rendered docs to not provide incorrect information and
consistent with how it's down for other machine classes.
2016-06-08 01:37:03 +03:00
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
93968bd6fb
docs/machine.UART: Cleanup pyboard section.
2016-06-08 01:32:16 +03:00
0a4361ca67
docs/machine.Pin: Remove explicit target.
...
With currentmodule:: support, all targets should be generated properly by
Sphinx.
2016-06-08 01:13:59 +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
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
2c5fc681c8
docs/library/machine.Pin: Mention GPIO and cross-link .value() function.
2016-06-07 17:49:00 +03:00
6e2fa5237d
docs/usocket: There must be empty line after .only:: .
2016-06-07 17:41:21 +03:00
9b18811951
docs/ure: Typo fix.
2016-06-07 08:53:54 +03:00
753a965363
docs/esp.socket: Remove unused file.
2016-06-07 02:40:05 +03:00
Damien George
Paul Sokolovsky
Alex March
Philip Potter
Radomir Dopieralski
Mike Causer
Martin Müller