Paul Sokolovsky
067bf849d2
docs/uselect: poll: Explicitly specify that no-timeout value is -1.
7 years ago
Peter Hinch
ec1e9a10a7
docs: Add notes on heap allocation caused by bound method refs.
7 years ago
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.
7 years ago
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.
7 years ago
Paul Sokolovsky
5b1b80a8db
docs/ure: Emphasize not supported features more.
Plus, additional descriptions/formatting.
7 years ago
Paul Sokolovsky
ad5a6f5917
docs/ure: Add flags arg to ure.compile(), mention that ure.DEBUG is optional.
7 years ago
Paul Sokolovsky
80e3f07e7f
docs/ure: Add "|" (alternative) to the list of supported operators.
7 years ago
Paul Sokolovsky
b81fbf938f
docs/usocket: Document that settimeout() isn't supported by all ports.
And describe an alternative of using uselect.poll().
7 years ago
Paul Sokolovsky
6fb093282b
docs/ussl: Fix module name refs and use "MicroPython port" term.
7 years ago
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
7 years ago
Paul Sokolovsky
a33fca99a1
docs/usocket: Document inet_ntop(), inet_pton().
7 years ago
Paul Sokolovsky
d1cd533134
docs/usocket: Elaborate descriptions.
Use the "usocket" module name everywhere. Use "MicroPython port"
terminology. Suggest to avoid using IPPROTO_* constants in socket()
call.
7 years ago
Paul Sokolovsky
328c1e78be
docs/uselect: Document one-shot polling mode.
7 years ago
Damien George
d90ade5e3e
docs/library/network: Update docs to state that W5500 is supported.
7 years ago
Damien George
65ba481cb0
stm32/modnwwiznet5k: Implement WIZNET5K.isconnected() method.
7 years ago
Mike Causer
b1457db002
docs/library: Add missing cross-ref links for classes in pyb module.
7 years ago
Damien George
add933feaf
docs/library/network: Clarify usage of "bssid" arg in connect() method.
7 years ago
Paul Sokolovsky
72491b3e40
docs/btree: Describe page caching policy of the underlying implementation.
7 years ago
Peter Hinch
d42b89bc3a
docs/library/framebuf.rst: Generalise constructor to all colour formats.
7 years ago
Damien George
fe6f0354f6
docs/library/micropython: Fix typo in RST formatting.
7 years ago
Damien George
e30ba2f1c7
docs/library: Add description of "index" parameter to uos.dupterm().
8 years ago
Paul Sokolovsky
d5336ba136
docs/machine.Signal: Improve style/grammar and add usage example.
7 years ago
Paul Sokolovsky
c5c095690f
docs/library/network: Fix ref to "socket" module (should be "usocket").
7 years ago
Paul Sokolovsky
358a7ba014
docs: More xrefs to "MicroPython port" in glossary.
7 years ago
Paul Sokolovsky
64a3c52f66
docs: Consistently link to micropython-lib in glossary.
7 years ago
Paul Sokolovsky
3f91570483
docs/library/usocket: Describe complete information on address formats.
Describe that the only portable way to deal with addresses is by using
getaddrinfo(). Describe that some ports may support tuple addresses using
"socket" module (vs "usocket" of native MicroPython).
7 years ago
Paul Sokolovsky
ccaad53270
docs/library/usocket: Move socket.error to its own section.
It's too minor a point to start the module description with it.
7 years ago
Alex Robbins
0aa1d3f447
docs/library/ubinascii: Update base64 docs.
This clarifies return values and the handling of invalid (e.g. newline)
characters.
Encoding conforms to RFC 3548, but decoding does not, as it ignores invalid
characters in base64 input. Instead, it conforms to MIME handling of base64
(RFC 2045).
Note that CPython doesn't document handling of invalid characters in
a2b_base64() docs:
https://docs.python.org/3/library/binascii.html#binascii.a2b_base64 , so
we specify it more explicitly than it, based on CPython's actual behavior
(with which MicroPython now compliant).
7 years ago
Javier Candeira
c127ace28a
docs/library/machine.RTC.rst: Fix typo.
7 years ago
Alexander Steffen
c9a48eb464
docs,teensy: Use the name MicroPython consistently in documentation
7 years ago
Paul Sokolovsky
503cf3d097
docs/uzlib: Update description of decompress() and mention DecompIO.
7 years ago
Paul Sokolovsky
ffb13cc633
docs/uerrno: Document "uerrno" module.
7 years ago
Paul Sokolovsky
465d84b7e7
docs/library: Add CPython docs xref to each pertinent module.
Cross-reference text/link is implemented as RST substitution, so easy to
consistently.
7 years ago
Paul Sokolovsky
d80ecad03f
docs/ure: Elaborate doc, update markup to the latest conventions.
7 years ago
Paul Sokolovsky
d42bb58c33
docs/builtins: Add AssertionError, SyntaxError, ZeroDivisionError.
Also, update heading of 1st sections to "Functions and types".
7 years ago
Paul Sokolovsky
8b7d311595
reference/index: Rewrite introduction paragraph to avoid confusion.
The old intro talked about "differences", but there were hardly any
sections describing differences, mostly MicroPython specific features.
On the other hand, we now have real "differences" chapter, though it's
mostly concerned with stdlib differences.
So, try to avoid confusion by changing wording and linking to the other
chapters and contrasting them with what is described in "MicroPython
language".
7 years ago
Paul Sokolovsky
871a45dd0c
docs/{uselect,ussl,ustruct}: Use markup adhering to latest docs conventions.
7 years ago
Paul Sokolovsky
1942f0ceef
docs/{framebuf,usocket}: Use markup adhering to the latest docs conventions.
7 years ago
Paul Sokolovsky
f8ac28964d
docs/{micropython,sys,uos}: Use markup adhering to the latest docs conventions.
7 years ago
Paul Sokolovsky
fbd252b77c
docs/{esp,pyb,ubinascii}: Use markup adhering to the latest docs conventions.
7 years ago
Damien George
7a4694fc4e
docs/library/gc: Fix grammar and improve readability of gc.threshold().
7 years ago
Paul Sokolovsky
dd16e21562
docs/network: Use markup adhering to the latest docs conventions.
7 years ago
Paul Sokolovsky
7c0e1f1a08
docs/machine*: Use markup adhering to the latest docs conventions.
7 years ago
Paul Sokolovsky
cfce7d784e
docs/lcd160cr: Group related constants together. Use full sentences.
Per the latest docs conventions.
7 years ago
Paul Sokolovsky
6f87b03e3c
docs/utime: Use markup adhering to the latest conventions.
7 years ago
Paul Sokolovsky
1e31d4bdf6
docs/lcd160cr: Use markup adhering to the latest conventions.
7 years ago
Paul Sokolovsky
7f2bc83dbc
docs/btree: Use markup adhering to the latest conventions.
7 years ago
Paul Sokolovsky
bc790b5145
docs/builtins: List builtin exceptions.
If for nothing else, then at least to cross-reference them.
7 years ago
Paul Sokolovsky
c4e3a03fa5
docs/gc: Document gc.threshold() function.
7 years ago
Paul Sokolovsky
4cdddfed8e
docs/gc: Mark mem_alloc()/mem_free() as uPy-specific.
7 years ago