diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2022-02-12 22:17:35 +0100 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2022-02-12 22:21:37 +0100 |
| commit | 08541fe11d1e3945549f33a013b3d655413dcfa6 (patch) | |
| tree | fab7725a431cd82c5c9d4e755340f15818f4d44b /doc/classes/String.xml | |
| parent | d3a6b6daaab4c8dfb7bdf35cc2fe2145ae6c22a1 (diff) | |
| download | redot-engine-08541fe11d1e3945549f33a013b3d655413dcfa6.tar.gz | |
Clarify identical `hash()` return values due to collisions
Diffstat (limited to 'doc/classes/String.xml')
| -rw-r--r-- | doc/classes/String.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/String.xml b/doc/classes/String.xml index a6182f5dab..6b8c455203 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -241,7 +241,8 @@ <method name="hash" qualifiers="const"> <return type="int" /> <description> - Hashes the string and returns a 32-bit integer. + Returns the 32-bit hash value representing the string's contents. + [b]Note:[/b] [String]s with equal content will always produce identical hash values. However, the reverse is not true. Returning identical hash values does [i]not[/i] imply the strings are equal, because different strings can have identical hash values due to hash collisions. </description> </method> <method name="hex_to_int" qualifiers="const"> |