diff options
| author | jess3jane <me@jess.coffee> | 2023-05-14 18:05:02 -0700 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2023-05-18 18:44:28 +0200 |
| commit | 2f9121dea63f1bd7fdff3bd43350398c058e5f92 (patch) | |
| tree | 8bba91fb1930c9e26f8e560fbd48ea1b89707324 | |
| parent | b40b35fb39f0d0768d7ec2976135adffdce1b96d (diff) | |
| download | redot-engine-2f9121dea63f1bd7fdff3bd43350398c058e5f92.tar.gz | |
Accurately document StringName comparisons
| -rw-r--r-- | doc/classes/StringName.xml | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/classes/StringName.xml b/doc/classes/StringName.xml index 7ffe1d8c32..932d50010a 100644 --- a/doc/classes/StringName.xml +++ b/doc/classes/StringName.xml @@ -1020,14 +1020,14 @@ <return type="bool" /> <param index="0" name="right" type="StringName" /> <description> - Returns [code]true[/code] if the left [String] comes before [param right] in [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode order[/url], which roughly matches the alphabetical order. Useful for sorting. + Returns [code]true[/code] if the left [StringName]'s pointer comes before [param right]. Note that this will not match their [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode order[/url]. </description> </operator> <operator name="operator <="> <return type="bool" /> <param index="0" name="right" type="StringName" /> <description> - Returns [code]true[/code] if the left [String] comes before [param right] in [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode order[/url], which roughly matches the alphabetical order, or if both are equal. + Returns [code]true[/code] if the left [StringName]'s pointer comes before [param right] or if they are the same. Note that this will not match their [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode order[/url]. </description> </operator> <operator name="operator =="> @@ -1048,14 +1048,14 @@ <return type="bool" /> <param index="0" name="right" type="StringName" /> <description> - Returns [code]true[/code] if the left [StringName] comes after [param right] in [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode order[/url], which roughly matches the alphabetical order. Useful for sorting. + Returns [code]true[/code] if the left [StringName]'s pointer comes after [param right]. Note that this will not match their [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode order[/url]. </description> </operator> <operator name="operator >="> <return type="bool" /> <param index="0" name="right" type="StringName" /> <description> - Returns [code]true[/code] if the left [StringName] comes after [param right] in [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode order[/url], which roughly matches the alphabetical order, or if both are equal. + Returns [code]true[/code] if the left [StringName]'s pointer comes after [param right] or if they are the same. Note that this will not match their [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode order[/url]. </description> </operator> </operators> |