summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWilson E. Alvarez <wilson.e.alvarez1@gmail.com>2021-08-23 16:53:12 -0400
committerWilson E. Alvarez <wilson.e.alvarez1@gmail.com>2021-08-23 19:55:06 -0400
commit69caa1ab4cf2ff408ce0b8d970dfacb3adfe0698 (patch)
treed08fae4f6f70141e364f2090e63923372749ec8b
parent0df9895eb755dba7ec9bd764c36fa873175bc256 (diff)
Update documentation for is_absolute_path and is_rel_path
-rw-r--r--doc/classes/String.xml4
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">