Skip to content

Commit de71806

Browse files
authored
Merge pull request #974 from igmtz/igmtz/link-Stream-class-to-library-style-guide-docs
Stream class documentation is now added to the Arduino Style Guide for Creating Libraries
2 parents 28b17c9 + 669a32c commit de71806

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

content/learn/08.contributions/01.arduino-library-style-guide/arduino-library-style-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This is a style guide to writing library APIs in an Arduino style. Some of these
2525
**Use the established core libraries and styles.**
2626

2727
* Use `read()` to read inputs, and `write()` to write to outputs, e.g. `digitalRead()`, `analogWrite()`, etc.
28-
* Use the `Stream` and `Print` classes when dealing with byte streams. If it’s not appropriate, at least try to use its API as a model. For more on this, see below
28+
* Use the [`Stream`](https://www.arduino.cc/reference/en/language/functions/communication/stream/) and `Print` classes when dealing with byte streams. If it’s not appropriate, at least try to use its API as a model. For more on this, see below
2929
* For network applications, use the `Client` and `Server` classes as the basis.
3030
* Use `begin()` to initialize a library instance, usually with some settings. Use `end()` to stop it.
3131
* Use camel case function names, not underscore. For example, **analogRead**, not **analog_read**. Or **myNewFunction**, not **my_new_function**. We've adopted this from Processing.org for readability's sake.

0 commit comments

Comments
 (0)