825460a093
docs: Bump version to 1.9.
2017-05-26 19:07:37 +10:00
3ebd67fc09
library/machine.Pin: Remove .id() method and .board class attr.
...
Both aren't part of generic Hardware API: It's impossible to implement
.id() method in a generic case (e.g., when Pin is instantiated by the
underlying OS/RTOS). .board attribute is an obvious space hog which
instead can be implemented on Python level if needed.
2017-05-21 15:50:16 +03:00
436d97b3f9
docs/library/machine.UART: Update and improve uart.any() docs.
2017-05-19 15:48:22 +10:00
d007351b33
docs/library/micropython: Document the newer micropython functions.
2017-05-18 00:25:09 +10:00
f351c6db5e
drivers/display/lcd160cr: Fix get_line method and enhance screen_dump.
...
The docs are updated and describe the new behaviour of these methods.
2017-05-17 19:53:13 +10:00
e4a53570d0
docs: Change single occurrence of "Micropython" to "MicroPython".
2017-05-17 12:38:33 +10:00
d5713c8618
docs/library/index: Add important summary of the intro section as warning.
...
To make them harder to miss.
2017-05-15 00:26:44 +03:00
0ba136fbe9
docs/machine.Signal: Add initial draft description of Signal class.
2017-05-14 23:12:06 +03:00
c19f07bd52
docs/machine.Pin: There's no toggle() method in MicroPython hardware API.
...
May be a port-specific method, not portable, not part of the official
specification.
2017-05-14 22:52:16 +03:00
6d221fe284
docs/library/uos: Add description of uos.ilistdir() function.
2017-05-10 12:44:21 +10:00
29b26f3922
docs/library/machine.SPI: Fix formatting of bullet list to stop warning.
2017-04-18 15:40:04 +10:00
850f79e552
docs/library/machine.I2C: Remove WiPy-specific return values.
...
cc3200 has been updated to conform to the API and now returns None.
2017-04-18 15:39:27 +10:00
daa5ba5629
docs/esp8266/quickref: Add links from quickref page to machine classes.
2017-04-18 15:28:18 +10:00
d4675e7674
docs/library/machine.*: Add cross-reference label to individual classes.
2017-04-18 15:27:37 +10:00
1f1a03d0c3
docs/library/machine.I2C: Deconditionalise all methods.
...
The cc3200 port is now similar enough to the standard machine.I2C API so
that all conditionals can be removed.
2017-04-18 15:04:51 +10:00
c49b265389
docs/wipy/general: Add section about specifics of I2C implementation.
2017-04-18 15:04:30 +10:00
27f0862550
docs/wipy/quickref: Update reference for change to I2C API.
2017-04-18 13:20:07 +10:00
fabaa61437
docs/library/machine.UART: Remove pyboard-specific section.
...
stmhal doesn't have a machine.UART class so this section is not needed.
2017-04-18 12:13:51 +10:00
a78703f188
docs/library/machine: Typo fix in machine_callbacks section.
2017-04-16 10:14:05 +03:00
9ef6bb5480
docs/machine: Move machine.main() misnomer to wipy's known issues.
2017-04-16 10:12:01 +03:00
a8ece0358f
docs/machine.UART: Deconditionalize normal methods.
2017-04-16 09:54:55 +03:00
ac8843ceec
docs/library/ussl: Deconditionalize, wipy notes moved to its documentation.
2017-04-16 09:41:32 +03:00
a0fb360f1b
docs/library/uos: urandom: Generalize description.
...
Don't give a guarantee of HW RNG, only a possibility of its usage.
2017-04-16 09:22:47 +03:00
ae831ec0a8
docs/library/micropython: Deconditionalize.
2017-04-16 09:18:47 +03:00
a1c39ffb69
docs/esp8266/tutorial/intro: Reword section on flash size requirement.
...
Give a clearly dissuading tone on end users trying 512KB version
- it has to many end-usery features lacking.
2017-04-14 01:12:04 +03:00
b87432b8fb
docs/uhashlib: Deconditionalize.
...
Notes on WiPy incompatibilities with the standard module API are
moved under "Known issues" to its documentation.
2017-04-09 00:57:54 +03:00
2e58474580
docs/usocket: Deconditionalize.
...
Notes on WiPy incompatibilities with the standard socket module API are
moved under "Known issues" to its documentation.
2017-04-09 00:48:28 +03:00
3acace588a
docs/utime: Deconditionalize description of sleep().
2017-04-09 00:42:32 +03:00
1d74559b6b
docs/library/machine.UART: Remove some conditionals.
2017-04-09 00:25:27 +03:00
bcf3c8bf17
docs/library/builtins: int: Add notice on byteorder param for to/from_bytes.
2017-04-09 00:06:54 +03:00
e5278b98fe
docs/esp8266/general: Start explicit "Known Issues", mentioned RTC inaccuracy.
2017-04-07 10:52:50 +03:00
390d5a3bf1
docs/machine.Pin: Move wipy-specific methods to its docs.
2017-04-05 13:05:04 +03:00
d46899626e
docs/machine.Pin: Move wipy-specific details to its own docs.
2017-04-05 12:09:36 +03:00
9a38b7afe0
cc3200/modmachine: Return frequency value directly, like other ports.
2017-04-05 11:58:17 +03:00
4333b2fb53
docs/machine.SPI: Remove outdated wipy chunk.
2017-04-05 11:47:15 +03:00
906d58f6f2
docs/uos: De-conditionalize statvfs() description.
...
It's a standard function, and it's already described (in the library
intro) that for any given port, any function may be missing.
2017-04-05 11:44:10 +03:00
0a861db91c
docs/utime: De-conditionalize description of sleep_ms() and friends.
...
These are basic MicroPython API, and all ports should implement them.
2017-04-05 11:40:47 +03:00
468c6f9da1
extmod/modframebuf: Make monochrome bitmap formats start with MONO_.
...
MONO_xxx is much easier to read if you're not familiar with the code.
MVLSB is deprecated but kept for backwards compatibility, for the time
being.
This patch also updates the associated docs and tests.
2017-04-04 17:38:33 +10:00
bb296482c3
docs/library/btree: Add btree module docs.
2017-04-04 00:29:23 +03:00
fb981107eb
docs/library/machine.I2C: Fix scan() doc to match implementation.
...
Since eaef6b5324
2017-03-20 15:30:41 +11:00
9b80a1e3e9
utime module documentation fixes and cleanup:
...
* Fix mis-spelling of `ticks_add` in code examples.
* Be consistent about parentheses after function names.
* Be consistent about formatting of function, variable and constant names.
* Be consistent about spaces and punctuation.
* Fix some language errors (missing or wrong words, wrong word order).
* Keep line length under 90 chars.
Signed-off-by: Christopher Arndt <chris@chrisarndt.de>
2017-03-17 20:45:08 +03:00
fcab435607
docs/library/framebuf: Fix typo in bit-width for MVLSB description.
2017-03-15 21:54:56 +11:00
e73a0b944f
docs/esp8266/tutorial: Update since esptool 1.3 added Python 3 support.
...
esptool 1.3 now supports both Python 2.7 and 3.4+.
Updated github link to now-official espressif repo.
2017-03-07 18:23:24 +11:00
2646b9e022
docs/library/lcd160cr: Add link to framebuf page.
2017-03-07 18:17:40 +11:00
f9d18d96b7
docs/library: Add framebuf documentation.
2017-03-07 18:16:46 +11:00
1f549a3496
docs/library/lcd160cr: Add note about supported JPEG format/encodings.
2017-02-28 17:45:24 +11:00
ed81574fe9
docs/machine: Fix formatting of Constants section.
...
Render related constants grouped together, with common description.
2017-02-28 00:38:15 +03:00
ae116c2430
docs/Makefile: define and use PYTHON as the interpreter for CPYDIFF
...
User can override PYTHON executable before running script,
gen-cpydiff.py works only with Python3 and most systems register
its executable as 'python3'.
2017-02-27 15:39:55 +11:00
e2f1a8a7ee
docs/uhashlib: Provide port-neutral description.
...
TODO: Remove WiPy-specific chunks.
2017-02-26 00:55:33 +03:00
3218ccd70d
docs: Modify Makefile and indexes to generate cPy-differences pages.
2017-02-20 17:14:35 +11:00
Damien George
Paul Sokolovsky
Peter Hinch
transistortim
Christopher Arndt
James Ouyang
Rami Ali
Krzysztof Blazewicz