Browse Source

Doc: Mention that Directory pre-opens res:// by default

This may be considered a bug, so we might change that in the future.
See #24149.
Rémi Verschelde 5 years ago
parent
commit
c6b6731857
1 changed files with 1 additions and 0 deletions
  1. 1 0
      doc/classes/Directory.xml

+ 1 - 0
doc/classes/Directory.xml

@@ -5,6 +5,7 @@
 	</brief_description>
 	<description>
 		Directory type. It is used to manage directories and their content (not restricted to the project folder).
+		When creating a new [Directory], its default opened directory will be [code]res://[/code]. This may change in the future, so it is advised to always use [method open] to initialize your [Directory] where you want to operate, with explicit error checking.
 		Here is an example on how to iterate through the files of a directory:
 		[codeblock]
 		func dir_contents(path):