From 1aa7e22b67473cfd6f50ea9808b827d39f43e6bb Mon Sep 17 00:00:00 2001
From: Juan Linietsky <reduzio@gmail.com>
Date: Sun, 17 Feb 2019 09:05:32 -0300
Subject: Clear up eof_reached function, fixes #16919

---
 doc/classes/File.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'doc/classes')

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">
-- 
cgit v1.2.3