search

arduino / reference-en

Editable source for the Arduino Reference
https://www.arduino.cc/reference/en/
Other
165 stars 732 forks source link

SD read() documentation needs additional information #966

Closed dgnuff closed 9 months ago

dgnuff commented 9 months ago

https://www.arduino.cc/reference/en/libraries/sd/read/

This page states:

Syntax file.read() file.read(buf, len)

and

Returns The next byte (or character), or -1 if none is available.

This is obviously the return value for the read() prototype. The page should also include a description of the return type from the read(buf, len) prototype.

per1234 commented 9 months ago

Thanks for your report @dgnuff. This issue tracker is only used for tracking tasks related to the Arduino Language Reference content that is hosted in this repository. So I will close this as off topic.

Issues related to the library references must be submitted to the issue tracker of the library's repository. I see this defect is already being tracked there: https://github.com/arduino-libraries/SD/issues/52