summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJuan Linietsky <reduzio@gmail.com>2019-02-17 09:05:32 -0300
committerJuan Linietsky <reduzio@gmail.com>2019-02-17 09:05:32 -0300
commit1aa7e22b67473cfd6f50ea9808b827d39f43e6bb (patch)
treee8b6da87d5ebe5f96d98d78b1699d6225b89eec0
parent623f7b64ae7ab075fe9cc7f5b7b2c777e774f81d (diff)
Clear up eof_reached function, fixes #16919
-rw-r--r--doc/classes/File.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/File.xml b/doc/classes/File.xml
index 6462176c73..c9a8f18116 100644
--- a/doc/classes/File.xml
+++ b/doc/classes/File.xml
@@ -38,7 +38,7 @@
<return type="bool">
</return>
<description>
- Returns [code]true[/code] if the file cursor has reached the end of the file.
+ Returns [code]true[/code] if the file cursor has read past the end of the file. Note that this function will still return [code]false[/code] while at the end of the file and only activates when reading past it. This can be confusing but it conforms to how low level file access works in all operating systems. There is always [method get_len] and [method get_position] to implement a custom logic.
</description>
</method>
<method name="file_exists" qualifiers="const">