From 22c80c1401494dad9e4d54df19a9cefef291344e Mon Sep 17 00:00:00 2001 From: Phoenixxl Date: Sat, 27 May 2023 17:22:11 +0200 Subject: [PATCH 1/2] Update api.md Read() returns different data depending on how it's used. --- docs/api.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index 1b4eabc..d3dbe36 100644 --- a/docs/api.md +++ b/docs/api.md @@ -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 occured. #### See also From 6de7f3b7d5eb480b852deea002b7bb6f2dde53a9 Mon Sep 17 00:00:00 2001 From: Phoenixxl Date: Sat, 27 May 2023 17:29:47 +0200 Subject: [PATCH 2/2] Update api.md --- docs/api.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api.md b/docs/api.md index d3dbe36..6cdcab9 100644 --- a/docs/api.md +++ b/docs/api.md @@ -571,11 +571,11 @@ file.read(buf, len) #### Returns -When used as `file.read()` +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 occured. +When used as `file.read(buf, len)`: +The amount of bytes read, or -1 if an error occurred. #### See also