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

improve typing for 'underdocumented' __init__ methods #465

Open
Josverl opened this issue Nov 28, 2023 · 0 comments
Open

improve typing for 'underdocumented' __init__ methods #465

Josverl opened this issue Nov 28, 2023 · 0 comments
Labels
stubber MicroPython-stubber CLI

Comments

@Josverl
Copy link
Owner

Josverl commented Nov 28, 2023

often init is well documented , where init is not
This is seen on multiple classess

for example _rp2.StateMachine

The constructor has minimal documentation
rp2.StateMachine(id[, program, ...])

    def __init__(self, id, program, *args, **kwargs) -> None: ...

While the init function has ample documentation.

StateMachine.init(program, freq=-1, *, in_base=None, out_base=None, set_base=None, jmp_pin=None, sideset_base=None, in_shiftdir=None, out_shiftdir=None, push_thresh=None, pull_thresh=None)

    def init(
        self,
        program,
        freq=-1,
        *,
        in_base=None,
        out_base=None,
        set_base=None,
        jmp_pin=None,
        sideset_base=None,
        in_shiftdir=None,
        out_shiftdir=None,
        push_thresh=None,
        pull_thresh=None,
    ) -> None:

@Josverl Josverl added the stubber MicroPython-stubber CLI label Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stubber MicroPython-stubber CLI
Projects
None yet
Development

No branches or pull requests

1 participant