Document which escape sequences are supported by String.c_unescape()

See https://github.com/godotengine/godot/issues/38716.
This commit is contained in:
Hugo Locurcio 2020-07-15 11:48:54 +02:00
parent dad21acebd
commit 04b25108ac

View file

@ -325,7 +325,8 @@
<return type="String"> <return type="String">
</return> </return>
<description> <description>
Returns a copy of the string with escaped characters replaced by their meanings according to the C language standard. Returns a copy of the string with escaped characters replaced by their meanings. Supported escape sequences are [code]\'[/code], [code]\"[/code], [code]\?[/code], [code]\\[/code], [code]\a[/code], [code]\b[/code], [code]\f[/code], [code]\n[/code], [code]\r[/code], [code]\t[/code], [code]\v[/code].
[b]Note:[/b] Unlike the GDScript parser, this method doesn't support the [code]\uXXXX[/code] escape sequence.
</description> </description>
</method> </method>
<method name="capitalize"> <method name="capitalize">
@ -413,7 +414,6 @@
</argument> </argument>
<description> <description>
Returns the index of the [b]first[/b] case-sensitive occurrence of the specified string in this instance, or [code]-1[/code]. Optionally, the starting search index can be specified, continuing to the end of the string. Returns the index of the [b]first[/b] case-sensitive occurrence of the specified string in this instance, or [code]-1[/code]. Optionally, the starting search index can be specified, continuing to the end of the string.
[b]Note:[/b] If you just want to know whether a string contains a substring, use the [code]in[/code] operator as follows: [b]Note:[/b] If you just want to know whether a string contains a substring, use the [code]in[/code] operator as follows:
[codeblock] [codeblock]
# Will evaluate to `false`. # Will evaluate to `false`.