Adds and modifies deprecation messages (#1202)

* Adds and modifies deprecation messages * Addresses Comments
firebase · May 1, 2018 · d8e9113 · d8e9113
1 parent d5e748d
commit d8e9113
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 26 deletions.
diff --git a/Firebase/Auth/Source/Public/FIRAuth.h b/Firebase/Auth/Source/Public/FIRAuth.h
@@ -429,10 +429,9 @@ NS_SWIFT_NAME(Auth)
                               password:(NSString *)password
                             completion:(nullable FIRAuthDataResultCallback)completion
                                 DEPRECATED_MSG_ATTRIBUTE(
-                                      "signInAndRetrieveDataWithEmail:password:completion: is "
-                                      "deprecated. Please use"
-                                      " signInWithEmail:password:completion: for Objective-C or"
-                                      " signIn(withEmail:password:completion:) for Swift instead.");
+                                      "Please use signInWithEmail:password:completion: for"
+                                      " Objective-C or signIn(withEmail:password:completion:) for"
+                                      " Swift instead.");
 
 /** @fn signInWithCredential:completion:
     @brief Please use `signInAndRetrieveDataWithCredential:completion:` for Objective-C or
@@ -475,11 +474,9 @@ NS_SWIFT_NAME(Auth)
  */
 - (void)signInWithCredential:(FIRAuthCredential *)credential
                   completion:(nullable FIRAuthResultCallback)completion DEPRECATED_MSG_ATTRIBUTE(
-                                      "signInWithCredential:completion: is"
-                                      " deprecated. Please use"
-                                      " signInAndRetrieveDataWithCredential:completion: for"
-                                      " Objective-C or signInAndRetrieveData(with:completion:) for"
-                                      " Swift instead.");
+                                      "Please use signInAndRetrieveDataWithCredential:completion:"
+                                      " for Objective-C or signInAndRetrieveData(with:completion:)"
+                                      " for Swift instead.");
 
 /** @fn signInAndRetrieveDataWithCredential:completion:
     @brief Asynchronously signs in to Firebase with the given 3rd-party credentials (e.g. a Facebook
@@ -564,8 +561,7 @@ NS_SWIFT_NAME(Auth)
  */
 - (void)signInAnonymouslyAndRetrieveDataWithCompletion:
     (nullable FIRAuthDataResultCallback)completion
-        DEPRECATED_MSG_ATTRIBUTE("signInAnonymouslyAndRetrieveDataWithCompletion: is deprecated."
-        " Please use signInAnonymouslyWithCompletion: for Objective-C or"
+        DEPRECATED_MSG_ATTRIBUTE("Please use signInAnonymouslyWithCompletion: for Objective-C or"
         " signInAnonymously(Completion:) for swift instead.");
 
 /** @fn signInWithCustomToken:completion:
@@ -616,8 +612,7 @@ NS_SWIFT_NAME(Auth)
 - (void)signInAndRetrieveDataWithCustomToken:(NSString *)token
                                   completion:(nullable FIRAuthDataResultCallback)completion
                                       DEPRECATED_MSG_ATTRIBUTE(
-                                      "signInAndRetrieveDataWithCustomToken:completion: is"
-                                      " deprecated. Please use signInWithCustomToken:completion:"
+                                      "Please use signInWithCustomToken:completion:"
                                       "for Objective-C or signIn(withCustomToken:completion:) for"
                                       " Swift instead.");
 
@@ -678,11 +673,9 @@ NS_SWIFT_NAME(Auth)
                                   password:(NSString *)password
                                 completion:(nullable FIRAuthDataResultCallback)completion
                                     DEPRECATED_MSG_ATTRIBUTE(
-                                      "createUserAndRetrieveDataWithEmail:password:completion: is"
-                                      " deprecated. Please use"
-                                      " createUserWithEmail:password:completion: for Objective-C or"
-                                      " createUser(withEmail:password:completion:) for Swift"
-                                      " instead.");
+                                      "Please use createUserWithEmail:password:completion: for"
+                                      " Objective-C or createUser(withEmail:password:completion:)"
+                                      " for Swift instead.");
 
 /** @fn confirmPasswordResetWithCode:newPassword:completion:
     @brief Resets the password given a code sent to the user outside of the app and a new password

diff --git a/Firebase/Auth/Source/Public/FIRUser.h b/Firebase/Auth/Source/Public/FIRUser.h
@@ -221,13 +221,18 @@ NS_SWIFT_NAME(User)
 - (void)reloadWithCompletion:(nullable FIRUserProfileChangeCallback)completion;
 
 /** @fn reauthenticateWithCredential:completion:
-    @brief Convenience method for `reauthenticateAndRetrieveDataWithCredential:completion:` This
-        method doesn't return additional identity provider data.
+    @brief Please use reauthenticateAndRetrieveDataWithCredential:completion: for Objective-C or
+        reauthenticateAndRetrieveData(WithCredential:completion:) for Swift instead.
  */
 - (void)reauthenticateWithCredential:(FIRAuthCredential *)credential
-                          completion:(nullable FIRUserProfileChangeCallback)completion;
-
-/** @fn reauthenticateWithCredential:completion:
+                          completion:(nullable FIRUserProfileChangeCallback)completion
+                              DEPRECATED_MSG_ATTRIBUTE( "Please use"
+                                      " reauthenticateAndRetrieveDataWithCredential:completion: for"
+                                      " Objective-C or"
+                                      " reauthenticateAndRetrieveData(WithCredential:completion:)"
+                                      " for Swift instead.");
+
+/** @fn reauthenticateAndRetrieveDataWithCredential:completion:
     @brief Renews the user's authentication tokens by validating a fresh set of credentials supplied
         by the user  and returns additional identity provider data.
 
@@ -322,11 +327,15 @@ NS_SWIFT_NAME(User)
                       completion:(nullable FIRAuthTokenCallback)completion;
 
 /** @fn linkWithCredential:completion:
-    @brief Convenience method for `linkAndRetrieveDataWithCredential:completion:` This method
-        doesn't return additional identity provider data.
+    @brief Please use linkAndRetrieveDataWithCredential:completion: for Objective-C or
+        linkAndRetrieveData(WithCredential:completion:) for Swift instead.
  */
 - (void)linkWithCredential:(FIRAuthCredential *)credential
-                completion:(nullable FIRAuthResultCallback)completion;
+                completion:(nullable FIRAuthResultCallback)completion DEPRECATED_MSG_ATTRIBUTE(
+                                      "Please use linkAndRetrieveDataWithCredential:completion: for"
+                                      " Objective-C or"
+                                      " linkAndRetrieveData(WithCredential:completion:) for"
+                                      " Swift instead.");
 
 /** @fn linkAndRetrieveDataWithCredential:completion:
     @brief Associates a user account from a third-party identity provider with this user and