Browse Source

Merge pull request #51905 from Calinou/doc-string-get-extension

Improve documentation for `String.get_extension()`
Rémi Verschelde 4 years ago
parent
commit
0168699d7a
1 changed files with 11 additions and 1 deletions
  1. 11 1
      doc/classes/String.xml

+ 11 - 1
doc/classes/String.xml

@@ -181,7 +181,17 @@
 		<method name="get_extension" qualifiers="const">
 			<return type="String" />
 			<description>
-				If the string is a valid file path, returns the extension.
+				Returns the extension without the leading period character ([code].[/code]) if the string is a valid file name or path. If the string does not contain an extension, returns an empty string instead.
+				[codeblock]
+				print("/path/to/file.txt".get_extension())  # "txt"
+				print("file.txt".get_extension())  # "txt"
+				print("file.sample.txt".get_extension())  # "txt"
+				print(".txt".get_extension())  # "txt"
+				print("file.txt.".get_extension())  # "" (empty string)
+				print("file.txt..".get_extension())  # "" (empty string)
+				print("txt".get_extension())  # "" (empty string)
+				print("".get_extension())  # "" (empty string)
+				[/codeblock]
 			</description>
 		</method>
 		<method name="get_file" qualifiers="const">