Merge pull request #52044 from Rubonnek/update-string-abs-rel-docs

Update documentation for is_absolute_path and is_rel_path
This commit is contained in:
Max Hilbrunner 2021-08-24 16:24:18 +02:00 committed by GitHub
commit 8a2730cac3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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">