Improve documentation for String.get_extension()

(cherry picked from commit 09eb98c530)
This commit is contained in:
Hugo Locurcio 2021-08-20 03:07:15 +02:00 committed by Rémi Verschelde
parent 052ca31a36
commit aa0de1c6e0
No known key found for this signature in database
GPG key ID: C3336907360768E1

View file

@ -316,7 +316,17 @@
<method name="get_extension">
<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">