diff options
| author | Yuri Sizov <11782833+YuriSizov@users.noreply.github.com> | 2023-05-18 20:53:46 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-18 20:53:46 +0200 |
| commit | 2dc3294ad4822c6872ad58431cd1c9a58306aeac (patch) | |
| tree | 8104abce1ce090c8a4747f5f61c96effd9e9e2ab | |
| parent | 0032c1c0c203ba225dd41bdc799f2e622bccfde5 (diff) | |
| parent | 2f9121dea63f1bd7fdff3bd43350398c058e5f92 (diff) | |
| download | redot-engine-2dc3294ad4822c6872ad58431cd1c9a58306aeac.tar.gz | |
Merge pull request #77083 from Jess3Jane/stringname-docs
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> |