arduino / arduino/docs-content
Links missing to reference for Stream and Print classes in the Library Style Guide
- Dominant language
- Python
- Stars
- 375
- Forks
- 555
- Avg merge
- 4d 3h
- Merged PRs (30d)
- 28
Description
In the body of the [Library Style Guide](https://github.com/arduino/docs-content/blob/main/content/learn/08.contributions/01.arduino-library-style-guide/arduino-library-style-guide.md) users are asked to, quote:
> **Use the established core libraries and styles.**
> [...]
> * Use the `Stream` and `Print` classes when dealing with byte streams.
However there aren't any links to the reference for those classes. Moreover I don't think there is documentation for them yet in these new docs. There's documentation for the `Stream` class [in the Reference](https://www.arduino.cc/reference/en/language/functions/communication/stream/), but it seems there isn't any for the `Print` class (at least judging by a quick search)
Contributor guide
Research direction
Open content/learn/08.contributions/01.arduino-library-style-guide/arduino-library-style-guide.md and inspect the quoted Stream and Print guidance. Check the linked Stream reference and search the documentation for a Print reference; done means the guidance provides appropriate class references, or the missing Print documentation path is clarified.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100