2
0
Эх сурвалжийг харах

Merge pull request #105932 from Rindbee/add-note-to-is_valid_filename

Clarify the conditions that need to be met for a valid file name in Godot
Thaddeus Crews 4 сар өмнө
parent
commit
8fd7311032

+ 1 - 1
doc/classes/String.xml

@@ -474,7 +474,7 @@
 		<method name="is_valid_filename" qualifiers="const">
 		<method name="is_valid_filename" qualifiers="const">
 			<return type="bool" />
 			<return type="bool" />
 			<description>
 			<description>
-				Returns [code]true[/code] if this string does not contain characters that are not allowed in file names ([code]:[/code] [code]/[/code] [code]\[/code] [code]?[/code] [code]*[/code] [code]"[/code] [code]|[/code] [code]%[/code] [code]&lt;[/code] [code]&gt;[/code]).
+				Returns [code]true[/code] if this string is a valid file name. A valid file name cannot be empty, begin or end with space characters, or contain characters that are not allowed ([code]:[/code] [code]/[/code] [code]\[/code] [code]?[/code] [code]*[/code] [code]"[/code] [code]|[/code] [code]%[/code] [code]&lt;[/code] [code]&gt;[/code]).
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="is_valid_float" qualifiers="const">
 		<method name="is_valid_float" qualifiers="const">

+ 1 - 1
doc/classes/StringName.xml

@@ -449,7 +449,7 @@
 		<method name="is_valid_filename" qualifiers="const">
 		<method name="is_valid_filename" qualifiers="const">
 			<return type="bool" />
 			<return type="bool" />
 			<description>
 			<description>
-				Returns [code]true[/code] if this string does not contain characters that are not allowed in file names ([code]:[/code] [code]/[/code] [code]\[/code] [code]?[/code] [code]*[/code] [code]"[/code] [code]|[/code] [code]%[/code] [code]&lt;[/code] [code]&gt;[/code]).
+				Returns [code]true[/code] if this string is a valid file name. A valid file name cannot be empty, begin or end with space characters, or contain characters that are not allowed ([code]:[/code] [code]/[/code] [code]\[/code] [code]?[/code] [code]*[/code] [code]"[/code] [code]|[/code] [code]%[/code] [code]&lt;[/code] [code]&gt;[/code]).
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="is_valid_float" qualifiers="const">
 		<method name="is_valid_float" qualifiers="const">