Skip to content

shared-bindings/sdioio/SDCard.c: fix example use of board.SDIO_DATA #10464

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

Merged
merged 1 commit into from
Jul 8, 2025

Conversation

dhalbert
Copy link
Collaborator

@dhalbert dhalbert commented Jul 8, 2025

board.SDIO_DATA on a number of boards is a tuple of four pins for use with sdioio.SDCARD(..., data=...)

The example in sdioio incorrectly put it in square brackets: [board.SDIO_DATA]. Remove those to use the intended tuple, and also include a sample line for boards that do not have this tuple but have board.SDIO_DATA0, board.SDIO_DATA1, board.SDIO_DATA2, board.SDIO_DATA3 pins instead.

Thanks Seth K in discord for discovering the doc problem.

I've also updated some examples in Learn Guides to point out board.SDIO_DATA is a tuple.

Maybe the tuple should be called board.SDIO_DATA_PINS, but good documentation will help for now.

@dhalbert dhalbert requested review from FoamyGuy and eightycc July 8, 2025 21:59
Copy link
Collaborator

@FoamyGuy FoamyGuy left a comment

Choose a reason for hiding this comment

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

Looks good to me, thank you!

@dhalbert dhalbert merged commit afbfa32 into adafruit:main Jul 8, 2025
130 checks passed
@dhalbert dhalbert deleted the fix-sdioio-data-doc branch July 8, 2025 22:34
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