Skip to content

docs: machine.UART.irq arguments are incorrect #14311

Closed
@AsensioL

Description

@AsensioL

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions