Skip to content

[Doc] improve documentation on return value of "read" #134

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.

Sign up for GitHub

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 2 commits into from
Mar 6, 2024
Merged

[Doc] improve documentation on return value of "read" #134

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22c80c1
Update api.md
Phoenixxl May 27, 2023
6de7f3b
Update api.md
Phoenixxl May 27, 2023
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
6 changes: 5 additions & 1 deletion docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -571,7 +571,11 @@ file.read(buf, len)

#### Returns

The next byte (or character), or -1 if none is available.
When used as `file.read()`:
The next byte (or character), or -1 if none is available.

When used as `file.read(buf, len)`:
The amount of bytes read, or -1 if an error occurred.

#### See also

Expand Down