Added method docs and comment.

CleverTap · Nov 14, 2024 · 909b924 · 909b924
1 parent 4c1e69a
commit 909b924
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/CleverTapSDK/CTUtils.h b/CleverTapSDK/CTUtils.h
@@ -14,7 +14,15 @@
 + (double)haversineDistance:(CLLocationCoordinate2D)coordinateA coordinateB:(CLLocationCoordinate2D)coordinateB;
 + (NSNumber * _Nullable)numberFromString:(NSString * _Nullable)string;
 + (NSNumber * _Nullable)numberFromString:(NSString * _Nullable)string withLocale:(NSLocale * _Nullable)locale;
+
+/**
+ * Get the CT normalized version of an event or a property name.
+ */
 + (NSString * _Nullable)getNormalizedName:(NSString * _Nullable)name;
+
+/**
+ * Check if two event/property names are equal with applied CT normalization
+ */
 + (BOOL)areEqualNormalizedName:(NSString * _Nullable)firstName andName:(NSString * _Nullable)secondName;
 
 @end
diff --git a/CleverTapSDK/CTUtils.m b/CleverTapSDK/CTUtils.m
@@ -144,6 +144,8 @@ + (NSNumber * _Nullable)numberFromString:(NSString * _Nullable)string withLocale
 
 + (NSString * _Nullable)getNormalizedName:(NSString * _Nullable)name {
     if (name) {
+        // Lowercase with English locale for consistent behavior with the backend
+        // and across different device locales.
         NSString *normalizedName = [name stringByReplacingOccurrencesOfString:@" " withString:@""];
         NSLocale *englishLocale = [[NSLocale alloc] initWithLocaleIdentifier:@"en_US"];
         normalizedName = [normalizedName lowercaseStringWithLocale:englishLocale];