Skip to content

Add missing timeout documentation to Stream functions #511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 4, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/parseFloat.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ title: Serial.parseFloat()

[float]
=== Description
`Serial.parseFloat()` returns the first valid floating point number from the Serial buffer. 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.
`Serial.parseFloat()` returns the first valid floating point number from the Serial buffer. 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. The function terminates if it times out (see link:../settimeout[Serial.setTimeout()]).

`Serial.parseFloat()` inherits from the link:../../stream[Stream] utility class.
[%hardbreaks]
Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/parseInt.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ title: Serial.parseInt()

[float]
=== Description
Looks for the next valid integer in the incoming serial.
Looks for the next valid integer in the incoming serial. The function terminates if it times out (see link:../settimeout[Serial.setTimeout()]).

`Serial.parseInt()` inherits from the link:../../stream[Stream] utility class.

Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Stream/streamFind.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ title: Stream.find()

[float]
=== Description
`find()` reads data from the stream until the target is found. The function returns true if target is found, false if timed out.
`find()` reads data from the stream until the target is found. The function returns true if target is found, false if timed out (see ../streamsettimeout[Stream.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.
[%hardbreaks]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ title: Stream.findUntil()

[float]
=== Description
`findUntil()` reads data from the stream until the target string of given length or terminator string is found.
`findUntil()` reads data from the stream until the target string of given length or terminator string is found, or it times out (see ../streamsettimeout[Stream.setTimeout()]).

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ title: Stream.parseFloat()

[float]
=== Description
`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.
`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. The function terminates if it times out (see ../streamsettimeout[Stream.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 informatio
[%hardbreaks]
Expand Down