From aa0de1c6e060d5709f04036fb7f16eb13e244ef1 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Fri, 20 Aug 2021 03:07:15 +0200 Subject: [PATCH] Improve documentation for `String.get_extension()` (cherry picked from commit 09eb98c5306f8d9a17287aa5a7509e17d56f2ee0) --- doc/classes/String.xml | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 52881babede..1e784554278 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -316,7 +316,17 @@ - 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]