Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

class __init__ for machine.UART is unspecific #725

Open
Josverl opened this issue Oct 25, 2023 · 1 comment
Open

class __init__ for machine.UART is unspecific #725

Josverl opened this issue Oct 25, 2023 · 1 comment
Assignees
Labels
Doc stubs Stubs generated from the MicroPython documentation enhancement New feature or request

Comments

@Josverl
Copy link
Owner

Josverl commented Oct 25, 2023

the documentation has an unclear specification for some of the init methods

the params for the init method should be
def __init__ ( self, id , <same params as init>) -> None: ...

machine.Timer

class Timer:
    def __init__(self, id, *args, **kwargs) -> None: ...
    def init(self, *, freq, prescaler, period, mode=UP, div=1, callback=None, deadtime=0) -> None:

machine.SPI

class SPI:
    def __init__(self, id, *args, **kwargs) -> None: ...
    def init(
        self, baudrate=1000000, *, polarity=0, phase=0, bits=8, firstbit=MSB, sck=None, mosi=None, miso=None, pins: Optional[Tuple]
    ) -> None:
class UART:
    def init(self, baudrate=9600, bits=8, parity=None, stop=1, *args, **kwargs) -> None: 
    def __init__(self, id, *args, **kwargs) -> None: ...
@Josverl Josverl added bug Something isn't working Doc stubs Stubs generated from the MicroPython documentation labels Oct 25, 2023
@Josverl Josverl self-assigned this Oct 25, 2023
@Josverl
Copy link
Owner Author

Josverl commented Oct 25, 2023

ref: paulober/Pico-W-Stub#7

@Josverl Josverl added enhancement New feature or request and removed bug Something isn't working labels Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Doc stubs Stubs generated from the MicroPython documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant