arduino / arduino/reference-en
missing stream methods information on Serial page
- Dominant language
- No language data
- Stars
- 173
- Forks
- 704
- PR merge metrics
- No merged PRs in 30d
Description
A page https://www.arduino.cc/reference/en/language/functions/communication/serial/ does not have description of methods readStringUntil() or readString() nor it does contain information that says all methods from https://www.arduino.cc/reference/en/language/functions/communication/stream/ are available on a Serial object.
Solution may be writing that all methods from stream are available on the Serial object (if this is true).
This issue is somewhat linked to https://github.com/arduino/Arduino/issues/3718
Contributor guide
No contributing guide indexed for this repository
Research direction
Compare the Serial reference page with the linked Stream reference page and verify whether readStringUntil(), readString(), and the other Stream methods are available on Serial objects. Update the Serial documentation with the confirmed method information and ensure the page clearly points readers to the applicable Stream methods.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- arduino
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100