Lerking/micropython
1
0
Fork 0
mirror of https://github.com/micropython/micropython.git synced 2026-01-05 03:30:14 +01:00
Code Issues Actions 52 Packages Projects Releases Wiki Activity
Files
7a15c97f069ed11fe0f7e697e240bec7eea4d0fb
micropython/docs/library
History
Alex Tran 7a15c97f06 docs/library/os: Clarify ilistdir tuples size element. 
The currently documentation for ilistdir tuples says that the size element
is included based on the platform. However, this is not the case as it is
included based on the filesystem type. This commit makes the according
adjustment.

Fixes issue #17516.

Signed-off-by: Alex Tran <alex.t.tran@gmail.com>
2025-11-21 13:47:02 +11:00
..
_thread.rst
docs/_thread: Add a placeholder docs for _thread module.
2017-11-10 00:09:43 +02:00
array.rst
docs/reference: Add strings vs bytes to speed optimisation tips.
2025-02-11 16:17:00 +11:00
asyncio.rst
docs/library/asyncio: Document that ThreadSafeFlag now works on unix.
2024-05-15 14:13:30 +10:00
binascii.rst
docs/library/binascii: Add docs for binascii.crc32 method.
2024-12-03 22:22:55 +11:00
bluetooth.rst
docs/library/bluetooth: Document all allowed args to UUID constructor.
2025-07-31 11:02:41 +10:00
btree.rst
docs/library/btree: Fix method links to explicitly specify class.
2025-08-01 22:58:26 +10:00
builtins.rst
docs/reference: Add strings vs bytes to speed optimisation tips.
2025-02-11 16:17:00 +11:00
cmath.rst
docs/library: Add CPython docs xref to each pertinent module.
2017-07-02 15:37:31 +03:00
collections.rst
docs/library/collections: Update deque docs to describe new features.
2024-03-19 10:09:11 +11:00
cryptolib.rst
docs: Replace ufoo with foo in all docs.
2021-08-13 22:53:29 +10:00
deflate.rst
extmod/moddeflate: Change default window size.
2023-09-01 12:23:37 +10:00
errno.rst
docs: Replace ufoo with foo in all docs.
2021-08-13 22:53:29 +10:00
esp32.rst
esp32/esp32_rmt: Update RMT module to use the new RMT API.
2025-11-17 10:45:19 +11:00
esp.rst
docs/library/esp: Correct the description of esp.osdebug().
2023-11-22 16:48:35 +11:00
espnow.rst
docs/library/espnow: Clarify usage of the "rate" configuration key.
2025-02-11 16:23:35 +11:00
framebuf.rst
extmod/modframebuf: Add support for blit'ing read-only data.
2025-06-04 02:40:45 +10:00
gc.rst
docs/library/gc: Clarify mem_alloc and mem_free only for Python heap.
2023-09-15 12:19:13 +10:00
gzip.rst
docs/library/deflate: Add docs for deflate.DeflateIO.
2023-07-21 19:32:42 +10:00
hashlib.rst
docs: Replace ufoo with foo in all docs.
2021-08-13 22:53:29 +10:00
heapq.rst
docs: Remove trailing spaces and convert tabs to spaces.
2021-12-15 11:49:22 +11:00
index.rst
docs/library/marshal: Document the marshal module.
2025-02-11 16:59:11 +11:00
io.rst
docs/library/io: Remove io.FileIO and io.TextIOWrapper.
2023-10-16 23:07:13 +11:00
json.rst
docs: Replace ufoo with foo in all docs.
2021-08-13 22:53:29 +10:00
lcd160cr.rst
docs: Remove trailing spaces and convert tabs to spaces.
2021-12-15 11:49:22 +11:00
machine.ADC.rst
all: Fix spelling mistakes based on codespell check.
2023-04-27 18:03:06 +10:00
machine.ADCBlock.rst
all: Prune trailing whitespace.
2024-03-07 16:25:17 +11:00
machine.ADCWiPy.rst
docs: Remove trailing spaces and convert tabs to spaces.
2021-12-15 11:49:22 +11:00
machine.Counter.rst
docs/library/machine: Add docs for Counter and Encoder.
2025-08-02 00:00:03 +10:00
machine.Encoder.rst
docs/library/machine: Add docs for Counter and Encoder.
2025-08-02 00:00:03 +10:00
machine.I2C.rst
all: Fix spelling mistakes based on codespell check.
2023-04-27 18:03:06 +10:00
machine.I2CTarget.rst
docs/library: Document the new machine.I2CTarget class.
2025-08-01 23:03:17 +10:00
machine.I2S.rst
docs: Rename uasyncio to asyncio.
2023-06-19 18:36:54 +10:00
machine.Pin.rst
docs/library/machine.Pin: Show availability of low, high and toggle.
2025-02-28 16:51:54 +11:00
machine.PWM.rst
docs/esp32: Improve PWM documentation and examples.
2025-05-16 12:34:32 +10:00
machine.rst
docs/library/machine: Add docs for Counter and Encoder.
2025-08-02 00:00:03 +10:00
machine.RTC.rst
ports: Fix machine.RTC.init() method so argument order matches the docs.
2024-12-19 16:04:47 +11:00
machine.SD.rst
docs: Use vfs module instead of os.
2024-02-07 13:25:10 +11:00
machine.SDCard.rst
esp32/machine_sdcard: Add SDCard SPI mode support for ESP32-S2,C3,C6.
2025-03-13 12:27:23 +11:00
machine.Signal.rst
docs/library/machine.Signal.rst: Correct typo: usecases to use cases.
2020-10-20 17:21:30 +11:00
machine.SPI.rst
all: Fix spelling mistakes based on codespell check.
2023-04-27 18:03:06 +10:00
machine.Timer.rst
docs: Document the cross-port Timer hard= option.
2025-09-25 23:59:24 +10:00
machine.TimerWiPy.rst
docs,ports: Fix some comments and error messages with doubled-up words.
2024-11-30 13:08:33 +11:00
machine.UART.rst
docs/esp32: Mention the use of Timer(0) by UART.IRQ_RXIDLE.
2025-05-28 12:13:51 +10:00
machine.USBDevice.rst
doc: Note that machine.USBDevice is now available on esp32 port.
2024-12-20 14:02:17 +11:00
machine.WDT.rst
docs/esp32: Update esp32 docs based on IDF v5 changes.
2023-06-23 15:34:49 +10:00
marshal.rst
docs/library/marshal: Document the marshal module.
2025-02-11 16:59:11 +11:00
math.rst
docs/library: Document math.log with two arguments.
2024-09-17 11:22:26 +10:00
micropython.rst
py/objringio: Add micropython.RingIO() interface for general use.
2024-09-19 18:00:44 +10:00
neopixel.rst
docs/library/neopixel: Mention bitstream timing tuple.
2024-08-01 12:04:58 +10:00
network.LAN.rst
docs/esp32: Add documentation for SPI Ethernet devices on esp32 port.
2025-02-11 12:56:42 +11:00
network.PPP.rst
docs: Note which ports have default or optional network.PPP support.
2025-02-11 16:11:33 +11:00
network.rst
docs/library: Document the network.PPP class.
2024-08-29 23:47:55 +10:00
network.WIZNET5K.rst
docs/esp32: Add documentation for SPI Ethernet devices on esp32 port.
2025-02-11 12:56:42 +11:00
network.WLAN.rst
esp8266/network_wlan: Allow enumerating connected stations in AP mode.
2025-03-05 16:15:31 +11:00
network.WLANWiPy.rst
docs: Update docs to replace ifconfig with ipconfig.
2024-07-05 16:06:04 +10:00
openamp.rst
docs/library/openamp: Document the new openamp module.
2024-03-15 18:11:28 +11:00
os.rst
docs/library/os: Clarify ilistdir tuples size element.
2025-11-21 13:47:02 +11:00
platform.rst
extmod/modplatform: Expose CPU features/extensions.
2025-09-11 11:58:29 +10:00
pyb.Accel.rst
docs/library: Remove unnecessary "pyb." prefix on class names.
2022-06-21 14:33:23 +10:00
pyb.ADC.rst
docs/library: Remove unnecessary "pyb." prefix on class names.
2022-06-21 14:33:23 +10:00
pyb.CAN.rst
stm32/pyb_can: Make pyb.CAN baud calculation a little more forgiving.
2025-01-17 12:13:17 +11:00
pyb.DAC.rst
docs/library: Remove unnecessary "pyb." prefix on class names.
2022-06-21 14:33:23 +10:00
pyb.ExtInt.rst
docs/library: Remove unnecessary "pyb." prefix on class names.
2022-06-21 14:33:23 +10:00
pyb.Flash.rst
docs/library: Move vfs functions and classes from os to vfs module docs.
2024-02-07 13:25:09 +11:00
pyb.I2C.rst
all: Fix spelling mistakes based on codespell check.
2023-04-27 18:03:06 +10:00
pyb.LCD.rst
docs/library: Remove unnecessary "pyb." prefix on class names.
2022-06-21 14:33:23 +10:00
pyb.LED.rst
docs/library: Remove unnecessary "pyb." prefix on class names.
2022-06-21 14:33:23 +10:00
pyb.Pin.rst
docs/library/pyb.Pin: Add Pin.ALT constant.
2022-07-29 12:16:32 +10:00
pyb.rst
docs: Add a "Reset and Boot Sequence" reference page.
2024-11-19 10:57:26 +11:00
pyb.RTC.rst
docs/library: Remove unnecessary "pyb." prefix on class names.
2022-06-21 14:33:23 +10:00
pyb.Servo.rst
docs/library: Remove unnecessary "pyb." prefix on class names.
2022-06-21 14:33:23 +10:00
pyb.SPI.rst
docs/library: Remove unnecessary "pyb." prefix on class names.
2022-06-21 14:33:23 +10:00
pyb.Switch.rst
docs/library: Remove unnecessary "pyb." prefix on class names.
2022-06-21 14:33:23 +10:00
pyb.Timer.rst
docs: Document the cross-port Timer hard= option.
2025-09-25 23:59:24 +10:00
pyb.UART.rst
docs/library: Remove unnecessary "pyb." prefix on class names.
2022-06-21 14:33:23 +10:00
pyb.USB_HID.rst
docs/library: Remove unnecessary "pyb." prefix on class names.
2022-06-21 14:33:23 +10:00
pyb.USB_VCP.rst
docs/library: Remove unnecessary "pyb." prefix on class names.
2022-06-21 14:33:23 +10:00
random.rst
all: Rename UMODULE to MODULE in preprocessor/Makefile vars.
2023-06-08 17:54:11 +10:00
re.rst
extmod/modre: Add support for start- and endpos.
2025-08-11 14:11:56 +10:00
rp2.DMA.rst
docs/library/rp2.DMA: Add documentation for rp2 DMA support.
2024-03-19 17:10:54 +11:00
rp2.Flash.rst
docs/library: Move vfs functions and classes from os to vfs module docs.
2024-02-07 13:25:09 +11:00
rp2.PIO.rst
rp2/rp2_pio: Add support for RP2350A/B variants in PIO interface.
2024-10-15 12:09:48 +11:00
rp2.rst
rp2/rp2_pio: Add side_pindir support for PIO.
2025-02-08 12:34:26 +11:00
rp2.StateMachine.rst
docs/library/rp2.StateMachine: Add a note about PIO in and jmp pins.
2025-08-01 15:10:15 +10:00
select.rst
docs: Replace ufoo with foo in all docs.
2021-08-13 22:53:29 +10:00
socket.rst
docs: Add a description of recv/recvfrom flags argument.
2025-06-03 12:52:25 +10:00
ssl.rst
extmod/mbedtls: Implement recommended DTLS features, make optional.
2025-07-23 15:47:16 +10:00
stm.rst
stm32/subghz: Add STM32WL55 subghz radio interface to stm module.
2023-08-23 11:58:11 +10:00
struct.rst
py/binary: Support half-float 'e' format in struct pack/unpack.
2024-03-20 14:13:49 +11:00
sys.rst
py/modsys: Add sys.implementation._thread attribute.
2025-07-22 23:22:05 +10:00
time.rst
docs/library/time: Amend the documentation of time.mktime().
2025-05-28 12:13:28 +10:00
uctypes.rst
docs: Replace ufoo with foo in all docs.
2021-08-13 22:53:29 +10:00
vfs.rst
docs/library/vfs: Document no-args mount output.
2025-03-27 16:37:04 +11:00
wipy.rst
docs: Add usocket and ussl modules' documentation.
2015-10-21 15:30:56 +02:00
wm8960.rst
docs,ports: Fix SparkFun capitalization.
2025-05-07 15:16:55 +10:00
zephyr.DiskAccess.rst
docs/library: Move vfs functions and classes from os to vfs module docs.
2024-02-07 13:25:09 +11:00
zephyr.FlashArea.rst
docs/library: Move vfs functions and classes from os to vfs module docs.
2024-02-07 13:25:09 +11:00
zephyr.rst
zephyr: Fix call to thread_analyzer_print for v4.0.
2025-04-29 23:00:37 +10:00
zephyr.zsensor.rst
zephyr/modzsensor: Add set/get sensor attributes to zsensor.
2025-10-13 12:06:24 +11:00
zlib.rst
docs/library/deflate: Add docs for deflate.DeflateIO.
2023-07-21 19:32:42 +10:00