Fix docs on Serial.readBytes return value #38
Merged
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
The way the docs were worded, it looked like the `readBytes` function would return a value of type `byte`, even though that's not true. When using a `byte` typed variable to store the number of bytes read value, an overflow occurs.
per1234
pushed a commit
to per1234/reference-en
that referenced
this pull request
May 7, 2022
Translated bitClear.adoc to German
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The way the docs were worded, it looked like the
readBytesfunctionwould return a value of type
byte, even though that's not true. Whenusing a
bytetyped variable to store the number of bytes read value,an overflow occurs.
According to the source code, the return type is
size_t.