Skip to content

fix return type doc in I2C.probe()#10891

Open
FoamyGuy wants to merge 1 commit intoadafruit:mainfrom
FoamyGuy:busio_docs_fix
Open

fix return type doc in I2C.probe()#10891
FoamyGuy wants to merge 1 commit intoadafruit:mainfrom
FoamyGuy:busio_docs_fix

Conversation

@FoamyGuy
Copy link
Collaborator

The return type List[int] and declared :rtype: bool in the docstring differ.

This changes the type annotation to match the correct type bool

Confirmed proper type in REPL:

>>> board.I2C().try_lock()
True
>>> board.I2C().probe(0x39)
True

Copy link
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants