Skip to content

Commit 3399b1c

Browse files
authored
Merge pull request #509 from per1234/stream-class-description-wording
Improve wording of Stream class description
2 parents 0ff7cf4 + aeaef5a commit 3399b1c

14 files changed

+14
-14
lines changed

Language/Functions/Communication/Stream/streamAvailable.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ title: Stream.available()
1515
=== Description
1616
`available()` gets the number of bytes available in the stream. This is only for bytes that have already arrived.
1717

18-
This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more information.
18+
This function is part of the Stream class, and can be called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more information.
1919
[%hardbreaks]
2020

2121

Language/Functions/Communication/Stream/streamFind.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ title: Stream.find()
1616
=== Description
1717
`find()` reads data from the stream until the target is found. The function returns true if target is found, false if timed out.
1818

19-
This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[stream class] main page for more information.
19+
This function is part of the Stream class, and can be called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[stream class] main page for more information.
2020
[%hardbreaks]
2121

2222

Language/Functions/Communication/Stream/streamFindUntil.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ title: Stream.findUntil()
1818

1919
The function returns true if target string is found, false if timed out
2020

21-
This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more information.
21+
This function is part of the Stream class, and can be called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more information.
2222
[%hardbreaks]
2323

2424

Language/Functions/Communication/Stream/streamFlush.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ title: Stream.flush()
1616
=== Description
1717
`flush()` clears the buffer once all outgoing characters have been sent.
1818

19-
This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[stream class] main page for more information.
19+
This function is part of the Stream class, and can be called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[stream class] main page for more information.
2020
[%hardbreaks]
2121

2222

Language/Functions/Communication/Stream/streamGetTimeout.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ title: Stream.getTimeout()
1414

1515
[float]
1616
=== Description
17-
`getTimeout()` returns the timeout value set by `setTimeout()`. This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more information.
17+
`getTimeout()` returns the timeout value set by `setTimeout()`. This function is part of the Stream class, and can be called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more information.
1818
[%hardbreaks]
1919

2020

Language/Functions/Communication/Stream/streamParseFloat.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ title: Stream.parseFloat()
1616
=== Description
1717
`parseFloat()` returns the first valid floating point number from the current position. Initial characters that are not digits (or the minus sign) are skipped. `parseFloat()` is terminated by the first character that is not a floating point number.
1818

19-
This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more informatio
19+
This function is part of the Stream class, and can be called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more informatio
2020
[%hardbreaks]
2121

2222

Language/Functions/Communication/Stream/streamParseInt.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ In particular:
2222
* Parsing stops when no characters have been read for a configurable time-out value, or a non-digit is read; +
2323
* If no valid digits were read when the time-out (see link:../streamsettimeout[Stream.setTimeout()]) occurs, 0 is returned;
2424

25-
This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more information.
25+
This function is part of the Stream class, and can be called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more information.
2626
[%hardbreaks]
2727

2828

Language/Functions/Communication/Stream/streamPeek.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ title: Stream.peek()
1616
=== Description
1717
Read a byte from the file without advancing to the next one. That is, successive calls to `peek()` will return the same value, as will the next call to `read()`.
1818

19-
This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more information.
19+
This function is part of the Stream class, and can be called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more information.
2020
[%hardbreaks]
2121

2222

Language/Functions/Communication/Stream/streamRead.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ title: Stream.read()
1616
=== Description
1717
`read()` reads characters from an incoming stream to the buffer.
1818

19-
This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[stream class] main page for more information.
19+
This function is part of the Stream class, and can be called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[stream class] main page for more information.
2020
[%hardbreaks]
2121

2222

Language/Functions/Communication/Stream/streamReadBytes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ title: Stream.readBytes()
1818

1919
`readBytes()` returns the number of bytes placed in the buffer. A 0 means no valid data was found.
2020

21-
This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more information.
21+
This function is part of the Stream class, and can be called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more information.
2222
[%hardbreaks]
2323

2424

0 commit comments

Comments
 (0)