Change the documentation to reflect that Directory.list_dir_begin()

returns true (not false) when a stream could not be initialized. (See, for
example,
https://github.com/godotengine/godot/blob/master/drivers/windows/dir_access_windows.cpp#L76
)

(cherry picked from commit cd82fafd58)
This commit is contained in:
Gastronok 2016-09-07 16:32:59 -07:00 committed by Rémi Verschelde
parent 85eca7bc93
commit 3b691907e9

View file

@ -10845,7 +10845,7 @@
</return>
<description>
Initialise the stream used to list all files and directories using the [method get_next] function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end].
Return false if the stream could not be initialised.
Return true if the stream could not be initialised.
</description>
</method>
<method name="list_dir_end">