docs: add an example to the detailed comment in compareUtf8Strings() #2383
Conversation
This file contains hidden or 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
…ttps://github.com/googleapis/nodejs-firestore into dconeybe/firestore/Utf8StringCompareCommentExample
MarkDuckworth
approved these changes
Jul 9, 2025
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.
This PR enhances the documentation for the
compareUtf8Strings()method by adding a concrete example. This example illustrates the nuances of comparing Unicode strings, particularly how characters represented by surrogate pairs in UTF-16 can compare differently than the lexicographical comparison of their UTF-8 encoding.This PR is in response to review comment firebase/firebase-android-sdk#7098 (review) and is a port of firebase/firebase-android-sdk#7113