Damien George
0db49c37a4
docs: Fix some references and RST markup to eliminate Sphinx warnings.
2018-03-15 15:50:51 +11:00
Tom Collins
4d3a92c67c
extmod/vfs_fat: Add file size as 4th element of uos.ilistdir tuple.
2018-03-12 12:26:36 +11:00
Damien George
9cef2b03a7
docs/reference/repl.rst: Fix some minor errors in the REPL tutorial.
2018-03-09 16:14:58 +11:00
Damien George
8359210e71
docs/library/uos: Document mount, umount, VfsFat and block devices.
2018-03-07 14:50:38 +11:00
Damien George
63b003d523
docs/library/uos: Create sections for distinct parts and document uname.
2018-03-07 14:49:25 +11:00
Damien George
a5fb699d87
docs/library/micropython: Describe optimisation levels for opt_level().
2018-03-05 19:10:45 +11:00
Damien George
6e09320b4c
docs/library/usocket: Make xref to uerrno explicitly a module reference.
2018-03-05 19:07:39 +11:00
Damien George
c5fe610ba1
esp8266/modnetwork: Implement WLAN.status('rssi') for STA interface.
...
This will return the RSSI of the AP that the STA is connected to.
2018-02-26 16:41:13 +11:00
Damien George
e05fca4ef3
docs/library/ujson: Document dump() and load() functions.
2018-02-15 11:37:48 +11:00
Damien George
9e8b7b1b63
docs/library/ujson: Update to conform with docs conventions.
...
The formatting of exception objects is done as per CPython conventions, eg:
:exc:`TypeError`
2018-02-15 11:31:34 +11:00
Olivier Ortigues
298b325f3e
docs/esp8266: Add a note concerning GPIO16 pull capabilities.
2018-02-15 11:15:12 +11:00
Olivier Ortigues
d072573226
docs/esp8266: Update PWM doc regarding clipping of min/max values.
2018-02-15 11:14:34 +11:00
Damien George
e708e87139
docs/library/pyb.rst: Add note about availability of USB MSC-only mode.
2018-02-01 15:52:49 +11:00
Paul Sokolovsky
5de064fbd0
docs/library/index: Elaborate uPy libraries intro.
2017-12-23 21:21:08 +02:00
Paul Sokolovsky
e37ccfe59b
docs/packages: Explicitly recommend usage of setuptools instead of distutils.
2017-12-16 10:42:30 +02:00
Paul Sokolovsky
9251f1395e
docs/packages: Use "install_dir/" in examples.
2017-12-16 10:37:36 +02:00
Paul Sokolovsky
02d2a0fb3a
docs/conf: Reference CPython 3.5 docs.
...
CPython 3.6 contains some backward incompatible changes, and further
version(s) are expected to have more. As we anyway implemente 3.4 with
some features of 3.5, refer to 3.5 docs to avoid confusion.
Examples of 3.6 backward incompatibilities:
https://docs.python.org/3.6/library/json.html#json.dump
https://docs.python.org/3.6/library/json.html#json.load
> Changed in version 3.6: All optional parameters are now keyword-only.
https://docs.python.org/3.6/library/functions.html#type
> Changed in version 3.6: Subclasses of type which don’t override
> type.__new__ may no longer use the one-argument form to get the
> type of an object.
https://docs.python.org/3.6/library/collections.html#collections.namedtuple
> Changed in version 3.6: The verbose and rename parameters became
> keyword-only arguments.
2017-12-16 01:22:46 +02:00
Paul Sokolovsky
448d93a04a
docs/glossary: micropython-lib: Clarify wording.
2017-12-15 00:11:02 +02:00
Paul Sokolovsky
bf73ee114f
docs/packages: mpy_bin2res no longer required to create resources.
...
Everything happens automagically with overridden "sdist" from
sdist_upip.py.
2017-12-14 18:28:10 +02:00
Damien George
46b35356e1
extmod/modframebuf: Add 8-bit greyscale format (GS8).
2017-12-14 17:36:13 +11:00
Petr Viktorin
34247465c3
extmod/modframebuf: Add 2-bit color format (GS2_HMSB).
...
This format is used in 2-color LED matrices and in e-ink displays like
SSD1606.
2017-12-14 17:13:02 +11:00
Ryan Finnie
1e2b78111b
docs/esp8266/tutorial: Fix typo, change -> changed.
2017-12-13 17:30:02 +11:00
Paul Sokolovsky
54cd6e3e4b
docs/packages: Add quick "Creating distribution packages" section.
...
Needs more details.
2017-12-13 00:12:37 +02:00
Paul Sokolovsky
c60fc670ea
docs/reference/packages: Add chapter on distribution packages and deployment.
...
A long overdue overview of preparing packages, installing them with upip,
freezing, dealing with resources. Initial version, more iterations required.
2017-12-11 00:08:41 +02:00
Paul Sokolovsky
ca8034d6b8
docs/glossary: Clarify wording for "baremetal".
2017-12-06 00:08:24 +02:00
Paul Sokolovsky
3ff7040c8a
docs/library: Add xrefs to "stream" dictionary entry for many modules.
2017-12-04 18:36:20 +02:00
Paul Sokolovsky
155ec21e49
docs/glossary: Describe string interning.
2017-12-04 01:01:03 +02:00
Paul Sokolovsky
8175f1608e
docs/glossary: Describe "stream" term.
2017-12-03 18:56:18 +02:00
Paul Sokolovsky
140acc9a32
docs/uerrno: Fix xref-vs-code markup.
2017-12-03 15:50:37 +02:00
Paul Sokolovsky
4fee35a32c
docs/glossary: Describe the callee-owned tuple concept.
2017-12-03 15:08:39 +02:00
Paul Sokolovsky
cb9da2279b
docs/uselect: ipoll: Fix grammar/wording of one-shot flag description.
2017-11-30 20:32:49 +02:00
Paul Carver
7d25a19220
docs/library/utime: Fix incorrect example with ticks_diff args order.
...
The parameter order in the example for ticks_diff was incorrect. If it's
"too early" that means that scheduled time is greater than current time and
if it's "running late" then scheduled time would be less than current time.
2017-11-30 14:56:08 +11:00
Paul Sokolovsky
f59c6b48ae
docs/uselect: Describe POLLHUP/POLLERR semantics in more details.
...
Per POSIX, http://pubs.opengroup.org/onlinepubs/9699919799/functions/poll.html
these flags aren't valid in the input eventmask. Instead, they can be
returned in unsolicited manner in the output eventmask at any time.
2017-11-26 09:58:19 +02:00
Paul Sokolovsky
50cffcfe2c
docs/uctypes: Tweak descriptor reference to hopefully be easier to follow.
...
Put offset first in OR expressions, and use "offset" var instead of
hardcoded numbers. Hopefully, this will make it more self-describing
and show patterns better.
2017-11-25 09:02:08 +02:00
Paul Sokolovsky
c23cc4cc81
docs/uctypes: Typo/article fixes.
2017-11-25 09:01:11 +02:00
Paul Sokolovsky
067bf849d2
docs/uselect: poll: Explicitly specify that no-timeout value is -1.
2017-11-23 18:03:32 +02:00
Peter Hinch
ec1e9a10a7
docs: Add notes on heap allocation caused by bound method refs.
2017-11-23 11:35:58 +11:00
Damien George
31550a52e4
docs/library/network: Enhance AbstractNIC.status to take an argument.
...
The argument is optional and if given should be a string naming the
status variable to query.
2017-11-16 14:48:04 +11:00
Paul Sokolovsky
579b86451d
docs/_thread: Add a placeholder docs for _thread module.
...
Doesn't list specific API calls yet, the purpose is to let user know that
the module exists.
2017-11-10 00:09:43 +02:00
Paul Sokolovsky
5b1b80a8db
docs/ure: Emphasize not supported features more.
...
Plus, additional descriptions/formatting.
2017-11-08 00:24:39 +02:00
Paul Sokolovsky
ad5a6f5917
docs/ure: Add flags arg to ure.compile(), mention that ure.DEBUG is optional.
2017-11-04 00:26:31 +02:00
Paul Sokolovsky
1742ab2653
docs/esp8266/general: Minor grammar fixes.
2017-11-02 00:38:58 +02:00
Paul Sokolovsky
58c785632f
docs/esp8266/general: TLS limitations: Mention also "ussl" module limitations.
2017-11-01 08:59:42 +02:00
Damien George
fe45d78b1e
docs: Bump version to 1.9.3.
2017-11-01 11:19:56 +11:00
Paul Sokolovsky
80e3f07e7f
docs/ure: Add "|" (alternative) to the list of supported operators.
2017-10-31 14:46:08 +02:00
Paul Sokolovsky
b81fbf938f
docs/usocket: Document that settimeout() isn't supported by all ports.
...
And describe an alternative of using uselect.poll().
2017-10-31 00:28:28 +02:00
Paul Sokolovsky
4dd523adbb
docs/esp8266/general: Add section on TLS limitations.
2017-10-30 19:50:57 +02:00
Paul Sokolovsky
6fb093282b
docs/ussl: Fix module name refs and use "MicroPython port" term.
2017-10-30 18:03:54 +02:00
Yuval Langer
05a2bb888f
docs/reference/isr_rules: Minor typo correction.
2017-10-30 13:29:00 +11:00
Joar Wandborg
b9923262db
docs/library/network: Add dhcp_hostname parameter
...
I have not actually tested this, going by information available in https://forum.micropython.org/viewtopic.php?t=2584
2017-10-27 11:04:52 +03:00
