Skip to content

docs: add an example to the detailed comment in compareUtf8Strings() #2183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 9, 2025

Conversation

dconeybe
Copy link
Contributor

@dconeybe dconeybe commented Jul 8, 2025

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

@dconeybe dconeybe self-assigned this Jul 8, 2025
@dconeybe dconeybe requested a review from a team as a code owner July 8, 2025 01:08
@product-auto-label product-auto-label bot added size: s Pull request size is small. api: firestore Issues related to the googleapis/java-firestore API. labels Jul 8, 2025
@dconeybe dconeybe requested a review from MarkDuckworth July 8, 2025 01:10
@dconeybe dconeybe merged commit e16b158 into main Jul 9, 2025
36 of 37 checks passed
@dconeybe dconeybe deleted the dconeybe/firestore/Utf8StringCompareCommentExample branch July 9, 2025 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: firestore Issues related to the googleapis/java-firestore API. size: s Pull request size is small.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants