← index #12545Issue #6855
Related · high · value 1.509
QUERY · ISSUE

docs: Documentation version don't match image contents

openby erichigginsopened 2023-09-28updated 2024-09-01
docsport-rp2

I'm developing with a Raspberry Pi Pico (RP2040) and a nightly image of v1.20.0

>>> sys.version
3.4.0; MicroPython v1.20.0-494-g72ef2e629 on 2023-09-27

Downloaded from:

  • https://micropython.org/download/RPI_PICO/

I've come across two cases so far when the documentation does not match what's actually on the UF2 images.

Examples:

  1. sys.atexit
    This function is referenced by the documentation for 1.20.0 and latest
    • https://docs.micropython.org/en/v1.20.0/library/sys.html#sys.atexit
    • https://docs.micropython.org/en/latest/library/sys.html#sys.atexit
      However, it is not defined
    import sys
    sys.__dict__
    {'__name__': 'sys', 'argv': [], 'version': '3.4.0; MicroPython v1.20.0-494-g72ef2e629 on 2023-09-27', 'version_info': (3, 4, 0), 'implementation': (name='micropython', version=(1, 20, 0), _machine='Raspberry Pi Pico with RP2040', _mpy=4358), 'platform': 'rp2', 'byteorder': 'little', 'maxsize': 2147483647, 'exit': <function>, 'stdin': <io.FileIO 0>, 'stdout': <io.FileIO 1>, 'stderr': <io.FileIO 2>, 'modules': {'font10': <module 'font10' from 'font10.py'>, 'rp2': <module 'rp2' from 'rp2.py'>}, 'print_exception': <function>}
    
  2. ustruct
    This module isn't defined in the documentation for 1.20.0 or latest, however, it can still be imported. My current assumption is that ustruct points to struct and they are not separate modules, but this is not reflected in the documentation.
    • https://docs.micropython.org/en/latest/search.html?q=ustruct&check_keywords=yes&area=default
    • https://docs.micropython.org/en/v1.20.0/search.html?q=ustruct&check_keywords=yes&area=default
    >>> import ustruct
    >>> print(ustruct.__dict__)
    {'__name__': 'struct', 'calcsize': <function>, 'pack': <function>, 'pack_into': <function>, 'unpack': <function>, 'unpack_from': <function>}
    >>> import struct
    >>> print(struct.__dict__)
    {'__name__': 'struct', 'calcsize': <function>, 'pack': <function>, 'pack_into': <function>, 'unpack': <function>, 'unpack_from': <function>}
    
CANDIDATE · ISSUE

rp2 API documentation

closedby tjvropened 2021-02-06updated 2022-03-07
docsport-rp2

👋 Is the rp2 port documented anywhere? In particular, the rp2-specific features like PIO.

I realise there are a bunch of examples provided by the Raspberry Pi people; I'm looking specifically for "API reference"-style documentation, e.g. a list of all possible arguments to StateMachine. The only reference I've managed to find so far is the C source code, which while I'm fine with that it's not the most beginner-friendly :)

At docs.micropython.org I see there is port-specific documentation for some of the chips, but not the RP2040/Pi Pico.

Is this documented somewhere and I missed it? Are there already plans to write documentation like this? Or is this an area where we're seeking contributions?

Cheers!

Keyboard

j / / n
next pair
k / / p
previous pair
1 / / h
show query pane
2 / / l
show candidate pane
c
copy suggested comment
r
toggle reasoning
g i
go to index
?
show this help
esc
close overlays

press ? or esc to close

copied