arduino / arduino/Arduino

Documentation for stream.find() and derivatives is too sparse

Open
#11,498 4 comments 0 reactions 1 assignee Claimed by @kengdahl View on GitHub
Component: Documentation Type: Bug
Dominant language
Java
Stars
14.6k
Forks
7k
PR merge metrics
No merged PRs in 30d

Description

The documentation for these functions is almost obscure. It mentions that a target string is searched for, but does not say that this is not a String object or null terminated array of char.

The documentation for Serial.find() says that characters are read from the buffer, but does not say that they are discarded.

The documentation for file.find() is not included in the documentation for the SD library. This function alters the file position, but this is not mentioned anywhere.

Every instance could be improved with a simple best use example.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.