correct identify doc (#114)

* fix identify doc issue

* add codecov to gha workflow

* add badges

* enable test coverage

* revert changes on codecov

Author: wenxi-zeng

README.md

@@ -1,4 +1,6 @@
 # Analytics-Swift
+![](https://github.com/segmentio/analytics-swift/actions/workflows/swift.yml/badge.svg)
+![](https://img.shields.io/github/license/segmentio/analytics-swift)
 
 NOTE: This project is currently in the Beta phase and is covered by Segment's [First Access & Beta Preview Terms](https://segment.com/legal/first-access-beta-preview/).  We encourage you
 to try out this new library. Please provide feedback via Github issues/PRs, and feel free to submit pull requests.

Sources/Segment/Events.swift

@@ -73,9 +73,10 @@ extension Analytics {
 
     /// Associate a user with their unique ID and record traits about them.
     /// - Parameters:
-    ///   - userId: A database ID (or email address) for this user. If you don't have a userId
-    ///     but want to record traits, you should pass nil. For more information on how we
-    ///     generate the UUID and Apple's policies on IDs, see https://segment.io/libraries/ios#ids
+    ///   - userId: A database ID (or email address) for this user.
+    ///     For more information on how we generate the UUID and Apple's policies on IDs, see
+    ///     https://segment.io/libraries/ios#ids
+    /// In the case when user logs out, make sure to call ``reset()`` to clear user's identity info.
     public func identify(userId: String) {
         let event = IdentifyEvent(userId: userId, traits: nil)
         store.dispatch(action: UserInfo.SetUserIdAction(userId: userId))
@@ -151,10 +152,11 @@ extension Analytics {
 
     /// Associate a user with their unique ID and record traits about them.
     /// - Parameters:
-    ///   - userId: A database ID (or email address) for this user. If you don't have a userId
-    ///     but want to record traits, you should pass nil. For more information on how we
-    ///     generate the UUID and Apple's policies on IDs, see https://segment.io/libraries/ios#ids
+    ///   - userId: A database ID (or email address) for this user.
+    ///     For more information on how we generate the UUID and Apple's policies on IDs, see
+    ///     https://segment.io/libraries/ios#ids
     ///   - traits: A dictionary of traits you know about the user. Things like: email, name, plan, etc.
+    /// In the case when user logs out, make sure to call ``reset()`` to clear user's identity info.
     public func identify(userId: String, traits: [String: Any]? = nil) {
         do {
             if let traits = traits {

Sources/Segment/ObjC/ObjCAnalytics.swift

@@ -38,20 +38,22 @@ extension ObjCAnalytics {
 
     /// Associate a user with their unique ID and record traits about them.
     /// - Parameters:
-    ///   - userId: A database ID (or email address) for this user. If you don't have a userId
-    ///     but want to record traits, you should pass nil. For more information on how we
-    ///     generate the UUID and Apple's policies on IDs, see https://segment.io/libraries/ios#ids
+    ///   - userId: A database ID (or email address) for this user.
+    ///     For more information on how we generate the UUID and Apple's policies on IDs, see
+    ///     https://segment.io/libraries/ios#ids
+    /// In the case when user logs out, make sure to call ``reset()`` to clear user's identity info.
     @objc(identify:)
     public func identify(userId: String) {
         identify(userId: userId, traits: nil)
     }
 
     /// Associate a user with their unique ID and record traits about them.
     /// - Parameters:
-    ///   - userId: A database ID (or email address) for this user. If you don't have a userId
-    ///     but want to record traits, you should pass nil. For more information on how we
-    ///     generate the UUID and Apple's policies on IDs, see https://segment.io/libraries/ios#ids
+    ///   - userId: A database ID (or email address) for this user.
+    ///     For more information on how we generate the UUID and Apple's policies on IDs, see
+    ///     https://segment.io/libraries/ios#ids
     ///   - traits: A dictionary of traits you know about the user. Things like: email, name, plan, etc.
+    /// In the case when user logs out, make sure to call ``reset()`` to clear user's identity info.
     @objc(identify:traits:)
     public func identify(userId: String, traits: [String: Any]?) {
         analytics.identify(userId: userId, traits: traits)