summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGastronok <hammerbroish@hotmail.com>2016-09-07 16:32:59 -0700
committerGastronok <hammerbroish@hotmail.com>2016-09-07 16:32:59 -0700
commitcd82fafd5810248e261ac633f9c942125d90906a (patch)
treeff026585cbf2c0a27a4de8cd0fdc4313926aefbc
parent462c171c65ed12b8b483e3021f91754f559c9e94 (diff)
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 )
-rw-r--r--doc/base/classes.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index e0b18e968b..1b54a70be8 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -10871,7 +10871,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">