← index #14536Issue #14311
Off-topic · high · value 0.449
QUERY · ISSUE

docs: Windows port README should include `make submodule` as a build step

openby mattytrentiniopened 2024-05-19updated 2024-07-06
docsport-windows

Checks

  • I agree to follow the MicroPython Code of Conduct to ensure a safe and respectful space for everyone.

  • I've searched for existing issues and didn't find any that matched.

Documentation URL

https://github.com/micropython/micropython/blob/master/ports/windows/README.md

Description

The build steps for the Windows port are missing make submodule. Build errors occur because micropython-lib (specifically the ssl module) isn't found if that command isn't executed.

CANDIDATE · ISSUE

docs: machine.UART.irq arguments are incorrect

closedby AsensioLopened 2024-04-16updated 2024-04-17

Checks

  • I agree to follow the MicroPython Code of Conduct to ensure a safe and respectful space for everyone.

  • I've searched for existing issues and didn't find any that matched.

Documentation URL

https://docs.micropython.org/en/latest/library/machine.UART.html

Description

The machine.UART.irq entry on the public docs has the following arguments:
UART.irq(trigger, priority=1, handler=None, wake=machine.IDLE)

However, looking at extmod/machine_uart.c, and in practice, machine.UART.irq behaves more like:
UART.irq(handler=None, trigger=0, hard=False).
Note that the position of handler is wrong, priority and wake should be removed and hard needs to be added.

I would like to update docs/library/machine.UART.rst to reflect the correct arguments.
But maybe other platforms handle machine.UART.irq differently, and I only use MicroPython on STM32 devices.

Please, let me know if that's the case and, if not, I'll proceed to fix and create a merge request.

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