aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
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-11-02docs/esp8266/general: Minor grammar fixes.Paul Sokolovsky
2017-11-01docs/esp8266/general: TLS limitations: Mention also "ussl" module limitations.Paul Sokolovsky
2017-11-01docs: Bump version to 1.9.3.Damien George
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/esp8266/general: Add section on TLS limitations.Paul Sokolovsky
2017-10-30docs/ussl: Fix module name refs and use "MicroPython port" term.Paul Sokolovsky
2017-10-30docs/reference/isr_rules: Minor typo correction.Yuval Langer
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-10docs/esp8266/quickref: Add quickref info for RTC class.Mike Causer
2017-10-10docs/pyboard/tutorial: Update now that yellow LED also supports PWM.Mike Causer
2017-10-10docs/pyboard/quickref: Add info for Switch, RTC, CAN, Accel classes.Mike Causer
2017-10-09docs/library/network: Clarify usage of "bssid" arg in connect() method.Damien George
2017-10-04docs/esp8266/tutorial: Update neopixel with example of using 4 bbp.Gabe
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-09-09docs/reference/isr_rules.rst Add tutorial on use of micropython.schedule().Peter Hinch
2017-09-06all: Update Makefiles and others to build with new ports/ dir layout.Damien George
Also renames "stmhal" to "stm32" in documentation and everywhere else.
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-23docs/pyboard/tutorial: Add "timeout=0" to UART in pass-through example.Damien George
Without this the pass-through will pause for 1 second at each character.
2017-08-23docs: Bump version to 1.9.2.Damien George
2017-08-22docs: Consistently link to micropython-lib in glossary.Paul Sokolovsky
2017-08-20docs/glossary: Fix typos in micropython-lib paragraph.Paul Sokolovsky
2017-08-20docs/glossary: Elaborate on possible MicroPython port differences.Paul Sokolovsky
State that this doc describes generic, "core" MicroPython functionality, any particular port may diverge in both directions, by both omitting some functionality, and adding more, both cases described outside the generic documentation.
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-24docs/esp8266/tutorial: Fix typo, "its" to "it's" in powerctrl.rst.Matthew Brener
2017-07-21eps8266/general: Fix typo in recent example.Paul Sokolovsky
2017-07-21eps8266/general: Add known issue of WiFi RX buffers overflow.Peter Hinch
2017-07-21docs/pyboard/tutorial/amp_skin: Add example for playing large WAV files.Piotr MaliƄski
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/pyboard: Move info about using Windows from topindex to general.Damien George
2017-07-02docs/esp8266/general.rst: Fix name of NTP module.Patrick O'Leary
The simple NTP client module is named "ntptime.py".