docs: Add missing read() method documentation to I2S library #2730
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes arduino#2583 Added comprehensive documentation for the read() method in the I2S library. The read() method was being used in examples but was not documented in the API reference. This commit adds: - Method description - Two syntax variants (single sample and buffer read) - Parameter documentation - Return value documentation This resolves the issue where users could not find documentation for the read() method despite it being used in code examples.
|
|
Contributor
|
Thank you @Gnanasaikiran. We've added a task in our backlog to review your PR ⭐ |
jhansson-ard
added
request
BenjaminDannegard
approved these changes
Dec 11, 2025
Contributor
BenjaminDannegard
left a comment
BenjaminDannegard
left a comment
There was a problem hiding this comment.
Changes look good! Thank you for the addition, I will go ahead and merge this request
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #2583
Added comprehensive documentation for the read() method in the I2S library.
The read() method was being used in examples but was not documented in the API reference. This commit adds:
This resolves the issue where users could not find documentation for the read() method despite it being used in code examples.
What This PR Changes
Contribution Guidelines