Skip to content

Commit a85dca1

Browse files
authored
Update readBytesUntil.adoc
As a side note, a function readBytesTill() which also copies the supplied terminator into the array (assuming it fits) would be convenient to add as it does allow to distinguish a time-out from a termination detection.
1 parent cbd3ffb commit a85dca1

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Language/Functions/Communication/Serial/readBytesUntil.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Data type: `size_t`.
4949

5050
[float]
5151
=== Notes and Warnings
52-
The terminator character is discarded from the serial buffer.
52+
The terminator character is discarded from the serial buffer, unless the return value equals `length`. If the return value is less than `length`, it cannot be determined whether this is due to a time-out or due to the detection of the supplied terminator.
5353
[%hardbreaks]
5454

5555
--

0 commit comments

Comments
 (0)