godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-04 12:00:25 +00:00
Code Releases Wiki Activity

Merge pull request #103264 from mhilbrunner/docs-path-join

Browse Source 
Rename "file" param for str.path_join() to "path"
This commit is contained in:
Thaddeus Crews
2025-05-07 12:48:29 -05:00
parent c714743bb1 3275116304
commit 051712dfb8
4 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
core/string/ustring.h
View File

@@ -520,7 +520,7 @@ public:
String rstrip(const String &p_chars) const; String rstrip(const String &p_chars) const;
String get_extension() const; String get_extension() const;
String get_basename() const; String get_basename() const;
String path_join(const String &p_file) const; String path_join(const String &p_path) const;
char32_t unicode_at(int p_idx) const; char32_t unicode_at(int p_idx) const;
CharString ascii(bool p_allow_extended = false) const; CharString ascii(bool p_allow_extended = false) const;

2
core/variant/variant_call.cpp
View File

@@ -1820,7 +1820,7 @@ static void _register_variant_builtin_methods_string() {
bind_string_method(rstrip, sarray("chars"), varray()); bind_string_method(rstrip, sarray("chars"), varray());
bind_string_method(get_extension, sarray(), varray()); bind_string_method(get_extension, sarray(), varray());
bind_string_method(get_basename, sarray(), varray()); bind_string_method(get_basename, sarray(), varray());
bind_string_method(path_join, sarray("file"), varray()); bind_string_method(path_join, sarray("path"), varray());
bind_string_method(unicode_at, sarray("at"), varray()); bind_string_method(unicode_at, sarray("at"), varray());
bind_string_method(indent, sarray("prefix"), varray()); bind_string_method(indent, sarray("prefix"), varray());
bind_string_method(dedent, sarray(), varray()); bind_string_method(dedent, sarray(), varray());

4
doc/classes/String.xml
View File

@@ -757,9 +757,9 @@
</method> </method>
<method name="path_join" qualifiers="const"> <method name="path_join" qualifiers="const">
<return type="String" /> <return type="String" />
<param index="0" name="file" type="String" /> <param index="0" name="path" type="String" />
<description> <description>
Concatenates [param file] at the end of the string as a subpath, adding [code]/[/code] if necessary. Concatenates [param path] at the end of the string as a subpath, adding [code]/[/code] if necessary.
[b]Example:[/b] [code]"this/is".path_join("path") == "this/is/path"[/code]. [b]Example:[/b] [code]"this/is".path_join("path") == "this/is/path"[/code].
</description> </description>
</method> </method>

4
doc/classes/StringName.xml
View File

@@ -665,9 +665,9 @@
</method> </method>
<method name="path_join" qualifiers="const"> <method name="path_join" qualifiers="const">
<return type="String" /> <return type="String" />
<param index="0" name="file" type="String" /> <param index="0" name="path" type="String" />
<description> <description>
Concatenates [param file] at the end of the string as a subpath, adding [code]/[/code] if necessary. Concatenates [param path] at the end of the string as a subpath, adding [code]/[/code] if necessary.
[b]Example:[/b] [code]"this/is".path_join("path") == "this/is/path"[/code]. [b]Example:[/b] [code]"this/is".path_join("path") == "this/is/path"[/code].
</description> </description>
</method> </method>