Переглянути джерело

Merge pull request #49042 from madmiraal/fix-docs-4085-3.x

[3.x] Clarify that eof_reached() cannot be used to check if more data is available
Max Hilbrunner 4 роки тому
батько
коміт
1d07feca54
1 змінених файлів з 6 додано та 2 видалено
  1. 6 2
      doc/classes/File.xml

+ 6 - 2
doc/classes/File.xml

@@ -38,8 +38,12 @@
 		<method name="eof_reached" qualifiers="const">
 			<return type="bool" />
 			<description>
-				Returns [code]true[/code] if the file cursor has read past the end of the file.
-				[b]Note:[/b] 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.
+				Returns [code]true[/code] if the file cursor has already read past the end of the file.
+				[b]Note:[/b] [code]eof_reached() == false[/code] cannot be used to check whether there is more data available. To loop while there is more data available, use:
+				[codeblock]
+				while file.get_position() &lt; file.get_len():
+				    # Read data
+				[/codeblock]
 			</description>
 		</method>
 		<method name="file_exists" qualifiers="const">