Add note to Unicode unaware methods #9339
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
martijnhoekstra
force-pushed
the
noteDeprecatedUnicode
branch
from
5022757
to
f487b29
Compare
|
arguably, the current implementation of |
|
squash please, and then let's merge |
|
Should mention that "unicode unaware" is not the opposite of "icode aware". |
Some methods in StringOps are unicode unaware and likely to return invalid strings if they are used without keeping surrogate pair handling in mind. These were previously deprecated, but were undeprecated again because they are useful in various contexts where unicode handling is not required.
martijnhoekstra
force-pushed
the
noteDeprecatedUnicode
branch
from
b58f12d
to
d78b087
Compare
|
squashed, unfortunately without icode or further double negation puns |
|
🎵 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Some methods in StringOps are Unicode unaware and likely to return invalid strings if they are used without keeping surrogate pair handling in mind. These were previously deprecated, but were undeprecated again because they are useful in various contexts where unicode handling is not required.
I've added notes on those methods that return strings, and Unicode unaware handling by the user may return invalid strings. I've not added notes on methods that don't return String or methods that won't return invalid strings if the user never returns or specifies part of a surrogate pair.
The deprecation was #6702, undeprecation was #9246, bug report scala/bug#10881
The note is added to the originally deprecated methods
diff,intersect,distinct,distinctBy,sorted,sortWith,sortBy,groupBy,sliding,combinationsandpermutations, as well as methods that change strings based on indices. Those where you may get it wrong for Unicode strings if you're doing naive index arithmetic around a surrogate pair:patch,slice,updated,tailandinit,take,drop,takeRight,dropRight, andsplitAt, and those that will always lead to invalid Unicode sequences if surrogate pairs are present:inits,tails,mkStringandreverse