arduino / arduino/reference-en
Behavior not documented: Stream.find() consumes the bytes and also the matched byte.
- Dominant language
- No language data
- Stars
- 173
- Forks
- 704
- PR merge metrics
- No merged PRs in 30d
Description
I'm refering to this function: https://www.arduino.cc/reference/en/language/functions/communication/stream/streamfind/
The behavior of the function `Stream.find()` is that it will consume every single byte in the inBuffer until it fins the matching target.
This is not documented nor expected from the name find(). One can expect a `find()` function to behave similar to `peek()` but it is not.
Contributor guide
No contributing guide indexed for this repository
Research direction
Open the Stream.find() reference page linked in the issue and review its current description. Document that the function consumes input bytes while searching and also consumes the matching byte, then verify the wording accurately reflects the reported behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- arduino
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100