[DOCUMENTATION] Clarify ambiguous String Documentation #100849
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation for the native String Class contains an ambiguity in the description of the CompareTo functions
(casecmp_to()
,nocasecmp_to()
,naturalcasecmpto()
, andnaturalnocasecmp_to()
The description currently reads:
When looking at an example such as
"aab".nocasecmp_to("aaaa")
The most direct interpretation of the current wording suggests the
nocasecmp_to()
would return-1
because this string is shorter than the to string. The actual behavior of the function is that it returns 1 because the character comparison reaches 'b' v. 'a' and determines 'b' and the first string are greater than the second string (matching the common definition of Lexicographical Order). The length comparison only occurs conditionally, if the comparison had not yet already resolved.I suggest updating this wording in the relevant to locations to
Which I believe more accurately communicates the behavior of the function. Thanks!