diff options
| author | Max Hilbrunner <mhilbrunner@users.noreply.github.com> | 2021-08-24 16:24:18 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-24 16:24:18 +0200 |
| commit | 8a2730cac3052d541e5eeffe0a0a0cd2ed80763c (patch) | |
| tree | a0b44abef5f02e7bca1390bfd07a953509afbf15 /doc | |
| parent | 61141793cab07bb400444779ed8e903b1ad95c22 (diff) | |
| parent | 69caa1ab4cf2ff408ce0b8d970dfacb3adfe0698 (diff) | |
Merge pull request #52044 from Rubonnek/update-string-abs-rel-docs
Update documentation for is_absolute_path and is_rel_path
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/String.xml | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 97efc24bd1..277eaa7376 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -239,7 +239,7 @@ <method name="is_absolute_path" qualifiers="const"> <return type="bool" /> <description> - If the string is a path to a file or directory, returns [code]true[/code] if the path is absolute. + Returns [code]true[/code] if the string is a path to a file or directory and its starting point is explicitly defined. This includes [code]res://[/code], [code]user://[/code], [code]C:\[/code], [code]/[/code], etc. </description> </method> <method name="is_empty" qualifiers="const"> @@ -251,7 +251,7 @@ <method name="is_rel_path" qualifiers="const"> <return type="bool" /> <description> - If the string is a path to a file or directory, returns [code]true[/code] if the path is relative. + Returns [code]true[/code] if the string is a path to a file or directory and its starting point is implicitly defined within the context it is being used. The starting point may refer to the current directory ([code]./[/code]), or the current [Node]. </description> </method> <method name="is_subsequence_of" qualifiers="const"> |