Skip to content
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

SD read() documentation needs additional information #966

Closed
dgnuff opened this issue Feb 6, 2024 · 1 comment
Closed

SD read() documentation needs additional information #966

dgnuff opened this issue Feb 6, 2024 · 1 comment
Assignees

Comments

@dgnuff
Copy link

dgnuff commented Feb 6, 2024

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 per1234 self-assigned this Feb 6, 2024
@per1234 per1234 added the bug label Feb 6, 2024
@per1234
Copy link
Collaborator

per1234 commented Feb 6, 2024

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: arduino-libraries/SD#52

@per1234 per1234 closed this as not planned Won't fix, can't repro, duplicate, stale Feb 6, 2024
@per1234 per1234 added the invalid label Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants