summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library
Commit message (Collapse)AuthorAge
* docs: Consistently link to micropython-lib in glossary.Paul Sokolovsky2017-08-22
|
* docs/library/usocket: Describe complete information on address formats.Paul Sokolovsky2017-08-20
| | | | | | 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).
* docs/library/usocket: Move socket.error to its own section.Paul Sokolovsky2017-08-20
| | | | It's too minor a point to start the module description with it.
* docs/library/ubinascii: Update base64 docs.Alex Robbins2017-08-17
| | | | | | | | | | | | | | | 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).
* docs/library/machine.RTC.rst: Fix typo.Javier Candeira2017-08-14
|
* docs,teensy: Use the name MicroPython consistently in documentationAlexander Steffen2017-07-15
|
* docs/uzlib: Update description of decompress() and mention DecompIO.Paul Sokolovsky2017-07-04
|
* docs/uerrno: Document "uerrno" module.Paul Sokolovsky2017-07-03
|
* docs/library: Add CPython docs xref to each pertinent module.Paul Sokolovsky2017-07-02
| | | | | Cross-reference text/link is implemented as RST substitution, so easy to consistently.
* docs/ure: Elaborate doc, update markup to the latest conventions.Paul Sokolovsky2017-07-02
|
* docs/builtins: Add AssertionError, SyntaxError, ZeroDivisionError.Paul Sokolovsky2017-07-01
| | | | Also, update heading of 1st sections to "Functions and types".
* reference/index: Rewrite introduction paragraph to avoid confusion.Paul Sokolovsky2017-07-01
| | | | | | | | | | | 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".
* docs/{uselect,ussl,ustruct}: Use markup adhering to latest docs conventions.Paul Sokolovsky2017-06-30
|
* docs/{framebuf,usocket}: Use markup adhering to the latest docs conventions.Paul Sokolovsky2017-06-29
|
* docs/{micropython,sys,uos}: Use markup adhering to the latest docs conventions.Paul Sokolovsky2017-06-28
|
* docs/{esp,pyb,ubinascii}: Use markup adhering to the latest docs conventions.Paul Sokolovsky2017-06-27
|
* docs/library/gc: Fix grammar and improve readability of gc.threshold().Damien George2017-06-26
|
* docs/network: Use markup adhering to the latest docs conventions.Paul Sokolovsky2017-06-26
|
* docs/machine*: Use markup adhering to the latest docs conventions.Paul Sokolovsky2017-06-25
|
* docs/lcd160cr: Group related constants together. Use full sentences.Paul Sokolovsky2017-06-25
| | | | Per the latest docs conventions.
* docs/utime: Use markup adhering to the latest conventions.Paul Sokolovsky2017-06-25
|
* docs/lcd160cr: Use markup adhering to the latest conventions.Paul Sokolovsky2017-06-25
|
* docs/btree: Use markup adhering to the latest conventions.Paul Sokolovsky2017-06-25
|
* docs/builtins: List builtin exceptions.Paul Sokolovsky2017-06-24
| | | | If for nothing else, then at least to cross-reference them.
* docs/gc: Document gc.threshold() function.Paul Sokolovsky2017-06-24
|
* docs/gc: Mark mem_alloc()/mem_free() as uPy-specific.Paul Sokolovsky2017-06-24
|
* docs/select: Rename to uselect, to match the actual module name.Paul Sokolovsky2017-06-16
| | | | | Also, add ipoll() documentation and markup changes to comply with CPython usage.
* stmhal: Add .value() method to Switch object, to mirror Pin and Signal.Damien George2017-06-15
|
* docs/btree: Typo/wording fixes.Paul Sokolovsky2017-06-11
|
* docs/btree: Add hints about opening db file and need to flush db.Paul Sokolovsky2017-06-11
|
* docs/network: First step to describe standard network class interface.Paul Sokolovsky2017-06-04
| | | | | | | | This adds description of implied AbstractNIC base class, which should be "subclasses" and implemented by a particular network device class. This is just an initial step in that direction, the API and description will be elabotated further.
* docs/machine: Sort machine classes in logical order, not alphabetically.Paul Sokolovsky2017-06-03
| | | | | | The list starts with the simplest functionality - GPIO, proceeds to communication interfaces (UART, SPI, I2C), the to time(r) related things, then everything else.
* docs/uos: Move cc3200 port legacy VFS mounting functions to its ref doc.Paul Sokolovsky2017-06-03
| | | | | This patch also unconditionalizes uos.dupterm(), though exact interface and semantics is yet to be defined.
* docs/uos: Deconditionalize, remove minor port-specific details.Paul Sokolovsky2017-06-03
| | | | | | | | | For a couple of ports, there was information which directory is set as current after boot. This information doesn't belong to "uos" module, and is moved to boards' references (which actually already contained information on which directory is chosen for boot, even if without explicit mentioning that it becomes current directory, which is now done).
* docs/network: Move confusingly-named cc3200 Server class to its reference.Paul Sokolovsky2017-06-03
| | | | | cc3200 port has network.Server class to control behavior of builtin Telnet/FTP server of that port.
* docs/machine.Pin: Add on() and off() methods.Paul Sokolovsky2017-05-29
|
* docs/machine.Pin: Remove out_value() method.Paul Sokolovsky2017-05-29
| | | | | | | | This method isn't implemented in any port. It seemed to have originated in cc3200 port, but actually never was implemented there either. In general case, it's impossible to implement this method (for example, for a perfect GPO, which has only output latch without any feedback look into a CPU).
* various: Spelling fixesVille Skyttä2017-05-29
|
* library/machine.Pin: Remove .id() method and .board class attr.Paul Sokolovsky2017-05-21
| | | | | | | 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.
* docs/library/machine.UART: Update and improve uart.any() docs.Damien George2017-05-19
|
* docs/library/micropython: Document the newer micropython functions.Damien George2017-05-18
|
* drivers/display/lcd160cr: Fix get_line method and enhance screen_dump.Damien George2017-05-17
| | | | The docs are updated and describe the new behaviour of these methods.
* docs/library/index: Add important summary of the intro section as warning.Paul Sokolovsky2017-05-15
| | | | To make them harder to miss.
* docs/machine.Signal: Add initial draft description of Signal class.Paul Sokolovsky2017-05-14
|
* docs/machine.Pin: There's no toggle() method in MicroPython hardware API.Paul Sokolovsky2017-05-14
| | | | | May be a port-specific method, not portable, not part of the official specification.
* docs/library/uos: Add description of uos.ilistdir() function.Damien George2017-05-10
|
* docs/library/machine.SPI: Fix formatting of bullet list to stop warning.Damien George2017-04-18
|
* docs/library/machine.I2C: Remove WiPy-specific return values.Damien George2017-04-18
| | | | cc3200 has been updated to conform to the API and now returns None.
* docs/library/machine.*: Add cross-reference label to individual classes.Damien George2017-04-18
|
* docs/library/machine.I2C: Deconditionalise all methods.Damien George2017-04-18
| | | | | The cc3200 port is now similar enough to the standard machine.I2C API so that all conditionals can be removed.
generated by cgit v1.2.3 (git 2.39.1) at 2025-06-16 02:11:51 +0000