aboutsummaryrefslogtreecommitdiff
path: root/docs/library
AgeCommit message (Collapse)Author
2018-02-15docs/library/ujson: Document dump() and load() functions.Damien George
2018-02-15docs/library/ujson: Update to conform with docs conventions.Damien George
The formatting of exception objects is done as per CPython conventions, eg: :exc:`TypeError`
2018-02-01docs/library/pyb.rst: Add note about availability of USB MSC-only mode.Damien George
2017-12-23docs/library/index: Elaborate uPy libraries intro.Paul Sokolovsky
2017-12-14extmod/modframebuf: Add 8-bit greyscale format (GS8).Damien George
2017-12-14extmod/modframebuf: Add 2-bit color format (GS2_HMSB).Petr Viktorin
This format is used in 2-color LED matrices and in e-ink displays like SSD1606.
2017-12-04docs/library: Add xrefs to "stream" dictionary entry for many modules.Paul Sokolovsky
2017-12-03docs/uerrno: Fix xref-vs-code markup.Paul Sokolovsky
2017-12-03docs/glossary: Describe the callee-owned tuple concept.Paul Sokolovsky
2017-11-30docs/uselect: ipoll: Fix grammar/wording of one-shot flag description.Paul Sokolovsky
2017-11-30docs/library/utime: Fix incorrect example with ticks_diff args order.Paul Carver
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-26docs/uselect: Describe POLLHUP/POLLERR semantics in more details.Paul Sokolovsky
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-25docs/uctypes: Tweak descriptor reference to hopefully be easier to follow.Paul Sokolovsky
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-25docs/uctypes: Typo/article fixes.Paul Sokolovsky
2017-11-23docs/uselect: poll: Explicitly specify that no-timeout value is -1.Paul Sokolovsky
2017-11-23docs: Add notes on heap allocation caused by bound method refs.Peter Hinch
2017-11-16docs/library/network: Enhance AbstractNIC.status to take an argument.Damien George
The argument is optional and if given should be a string naming the status variable to query.
2017-11-10docs/_thread: Add a placeholder docs for _thread module.Paul Sokolovsky
Doesn't list specific API calls yet, the purpose is to let user know that the module exists.
2017-11-08docs/ure: Emphasize not supported features more.Paul Sokolovsky
Plus, additional descriptions/formatting.
2017-11-04docs/ure: Add flags arg to ure.compile(), mention that ure.DEBUG is optional.Paul Sokolovsky
2017-10-31docs/ure: Add "|" (alternative) to the list of supported operators.Paul Sokolovsky
2017-10-31docs/usocket: Document that settimeout() isn't supported by all ports.Paul Sokolovsky
And describe an alternative of using uselect.poll().
2017-10-30docs/ussl: Fix module name refs and use "MicroPython port" term.Paul Sokolovsky
2017-10-27docs/library/network: Add dhcp_hostname parameterJoar Wandborg
I have not actually tested this, going by information available in https://forum.micropython.org/viewtopic.php?t=2584
2017-10-27docs/usocket: Document inet_ntop(), inet_pton().Paul Sokolovsky
2017-10-26docs/usocket: Elaborate descriptions.Paul Sokolovsky
Use the "usocket" module name everywhere. Use "MicroPython port" terminology. Suggest to avoid using IPPROTO_* constants in socket() call.
2017-10-26docs/uselect: Document one-shot polling mode.Paul Sokolovsky
2017-10-16docs/library/network: Update docs to state that W5500 is supported.Damien George
2017-10-16stm32/modnwwiznet5k: Implement WIZNET5K.isconnected() method.Damien George
2017-10-11docs/library: Add missing cross-ref links for classes in pyb module.Mike Causer
2017-10-09docs/library/network: Clarify usage of "bssid" arg in connect() method.Damien George
2017-09-17docs/btree: Describe page caching policy of the underlying implementation.Paul Sokolovsky
2017-09-13docs/library/framebuf.rst: Generalise constructor to all colour formats.Peter Hinch
2017-08-29docs/library/micropython: Fix typo in RST formatting.Damien George
2017-08-29docs/library: Add description of "index" parameter to uos.dupterm().Damien George
2017-08-29docs/machine.Signal: Improve style/grammar and add usage example.Paul Sokolovsky
2017-08-28docs/library/network: Fix ref to "socket" module (should be "usocket").Paul Sokolovsky
2017-08-28docs: More xrefs to "MicroPython port" in glossary.Paul Sokolovsky
2017-08-22docs: Consistently link to micropython-lib in glossary.Paul Sokolovsky
2017-08-20docs/library/usocket: Describe complete information on address formats.Paul Sokolovsky
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).
2017-08-20docs/library/usocket: Move socket.error to its own section.Paul Sokolovsky
It's too minor a point to start the module description with it.
2017-08-17docs/library/ubinascii: Update base64 docs.Alex Robbins
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).
2017-08-14docs/library/machine.RTC.rst: Fix typo.Javier Candeira
2017-07-15docs,teensy: Use the name MicroPython consistently in documentationAlexander Steffen
2017-07-04docs/uzlib: Update description of decompress() and mention DecompIO.Paul Sokolovsky
2017-07-03docs/uerrno: Document "uerrno" module.Paul Sokolovsky
2017-07-02docs/library: Add CPython docs xref to each pertinent module.Paul Sokolovsky
Cross-reference text/link is implemented as RST substitution, so easy to consistently.
2017-07-02docs/ure: Elaborate doc, update markup to the latest conventions.Paul Sokolovsky
2017-07-01docs/builtins: Add AssertionError, SyntaxError, ZeroDivisionError.Paul Sokolovsky
Also, update heading of 1st sections to "Functions and types".
2017-07-01reference/index: Rewrite introduction paragraph to avoid confusion.Paul Sokolovsky
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".