Skip to content

Commit 35be4e8

Browse files
author
Rachel Prince
committed
Make java doc tense and language more consistent
1 parent 4e9ac0e commit 35be4e8

File tree

8 files changed

+32
-28
lines changed

8 files changed

+32
-28
lines changed

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/ApkInstaller.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ private void startInstallActivity(String path, Activity currentActivity) {
7979
Intent intent = new Intent(currentActivity, InstallActivity.class);
8080
intent.putExtra("INSTALL_PATH", path);
8181
currentActivity.startActivity(intent);
82-
LogWrapper.getInstance().v(TAG + "Prompting user with install activity ");
82+
LogWrapper.getInstance().v(TAG + "Prompting tester with install activity ");
8383
}
8484

8585
void trySetInstallTaskError() {

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/AppDistributionRelease.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,19 @@ static Builder builder() {
3030
return new com.google.firebase.appdistribution.AutoValue_AppDistributionRelease.Builder();
3131
}
3232

33-
/** The short bundle version of this build (example: 1.0.0). */
33+
/** Returns the short bundle version of this build (example: 1.0.0). */
3434
@NonNull
3535
public abstract String getDisplayVersion();
3636

37-
/** The version code of this build (example: 123). */
37+
/** Returns the version code of this build (example: 123). */
3838
@NonNull
3939
public abstract long getVersionCode();
4040

41-
/** The release notes for this build. */
41+
/** Returns the release notes for this build. */
4242
@Nullable
4343
public abstract String getReleaseNotes();
4444

45-
/** The binary type for this build. */
45+
/** Returns the binary type for this build. */
4646
@NonNull
4747
public abstract BinaryType getBinaryType();
4848

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistribution.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -141,15 +141,16 @@ public static FirebaseAppDistribution getInstance() {
141141
/**
142142
* Updates the app to the newest release, if one is available.
143143
*
144-
* <p>Returns the release information or null if no update is found. Performs the following
145-
* actions:
144+
* <p>Returns the release information or {@code null} if no update is found. Performs the
145+
* following actions:
146146
*
147147
* <ol>
148-
* <li>If tester is not signed in, presents the tester with a Google sign in UI.
148+
* <li>If tester is not signed in, presents the tester with a Google Sign-in UI.
149149
* <li>Checks if a newer release is available. If so, presents the tester with a confirmation
150150
* dialog to begin the download.
151-
* <li>For APKs, downloads the binary and starts an installation intent. For AABs, directs the
152-
* tester to the Google Play app to complete the download and installation.
151+
* <li>If the newest release is an APK, downloads the binary and starts an installation. If the
152+
* newest release is an AAB, directs the tester to the Play app to complete the download and
153+
* installation.
153154
* </ol>
154155
*/
155156
@NonNull

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistributionException.java

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,20 @@ public enum Status {
3131
*/
3232
AUTHENTICATION_FAILURE,
3333

34-
/** The authentication process was canceled (typically by the user). */
34+
/** The authentication process was canceled (typically by the tester). */
3535
AUTHENTICATION_CANCELED,
3636

3737
/**
38-
* No network is available to make requests, or the request timed out. Check your internet
39-
* connection and try again.
38+
* No network was available to make requests, or the request timed out. Check the tester's
39+
* internet connection and retrying the call to {@link FirebaseAppDistribution}.
4040
*/
4141
NETWORK_FAILURE,
4242

4343
/**
44-
* The new release failed to download. This is a most likely due to a transient condition and
45-
* may be corrected by retrying.
44+
* The new release failed to download. This was a most likely due to a transient condition and
45+
* may be corrected by retrying the call to {@link
46+
* FirebaseAppDistribution#updateIfNewReleaseAvailable} or {@link
47+
* FirebaseAppDistribution#updateApp}.
4648
*/
4749
DOWNLOAD_FAILURE,
4850

@@ -52,13 +54,13 @@ public enum Status {
5254
*/
5355
INSTALLATION_FAILURE,
5456

55-
/** The installation was canceled (typically by the user). */
57+
/** The installation was canceled (typically by the tester). */
5658
INSTALLATION_CANCELED,
5759

5860
/**
59-
* An update is not available for the current tester and app. Make sure that {@link
60-
* FirebaseAppDistribution#checkForNewRelease()} returns with a non-null {@link
61-
* AppDistributionRelease} before calling {@link FirebaseAppDistribution#updateApp()},
61+
* An update was not available for the current tester and app. Make sure that {@link
62+
* FirebaseAppDistribution#checkForNewRelease} returns with a non-null {@link
63+
* AppDistributionRelease} before calling {@link FirebaseAppDistribution#updateApp},
6264
*/
6365
UPDATE_NOT_AVAILABLE,
6466

@@ -128,7 +130,7 @@ static class ErrorMessages {
128130
"Failed to fetch releases due to unknown network error.";
129131

130132
public static final String JSON_PARSING_ERROR =
131-
"Error parsing service response when checking for new release. This is a most likely due to a transient condition and may be corrected by retrying.";
133+
"Error parsing service response when checking for new release. This was most likely due to a transient condition and may be corrected by retrying.";
132134

133135
public static final String AUTHENTICATION_ERROR =
134136
"Failed to authenticate the tester. The tester was either not signed in, or something went wrong. Try signing in again.";
@@ -139,17 +141,17 @@ static class ErrorMessages {
139141
public static final String AUTHENTICATION_CANCELED = "Tester canceled the authentication flow.";
140142

141143
public static final String NOT_FOUND_ERROR =
142-
"Release not found. An update is not available for the current tester and app. Make sure that FirebaseAppDistribution#checkForNewRelease returns with a non-null AppDistributionRelease before calling FirebaseAppDistribution#updateApp";
144+
"Release not found. An update was not available for the current tester and app. Make sure that FirebaseAppDistribution#checkForNewRelease returns with a non-null AppDistributionRelease before calling FirebaseAppDistribution#updateApp";
143145

144146
public static final String TIMEOUT_ERROR =
145-
"Failed to fetch releases due to timeout. Check your internet connection and try again.";
147+
"Failed to fetch releases due to timeout. Check the tester's internet connection and try again.";
146148

147149
public static final String UPDATE_CANCELED = "Tester canceled the update.";
148150

149151
public static final String UNKNOWN_ERROR = "Unknown error.";
150152

151153
public static final String DOWNLOAD_URL_NOT_FOUND =
152-
"Download URL not found. This is a most likely due to a transient condition and may be corrected by retrying.";
154+
"Download URL not found. This was a most likely due to a transient condition and may be corrected by retrying.";
153155

154156
public static final String HOST_ACTIVITY_INTERRUPTED =
155157
"Host activity interrupted while dialog was showing. Try calling FirebaseAppDistribution#updateIfNewReleaseAvailable again.";

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/TaskUtils.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ interface Operation<TResult> {
3838
*
3939
* <p>This allows long running operations to be chained together using {@link Task#onSuccessTask}.
4040
* If the operation throws an exception, the task will fail, and the exception will be surfaced to
41-
* the user as {@code FirebaseAppDistributionException}, available via {@link Task#getException}.
41+
* the caller as {@code FirebaseAppDistributionException}, available via {@link
42+
* Task#getException}.
4243
*
4344
* <p>Exceptions that are not {@code FirebaseAppDistributionException} will be wrapped in one,
4445
* with {@link Status#UNKNOWN}.

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/UpdateProgress.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ static UpdateProgress.Builder builder() {
2828
}
2929

3030
/**
31-
* The number of bytes downloaded so far for an APK.
31+
* Returns the number of bytes downloaded so far for an APK.
3232
*
3333
* @returns the number of bytes downloaded, or -1 if called when updating to an AAB or if no new
3434
* release is available.
@@ -37,7 +37,7 @@ static UpdateProgress.Builder builder() {
3737
public abstract long getApkBytesDownloaded();
3838

3939
/**
40-
* The file size of the APK file to download in bytes.
40+
* Returns the file size of the APK file to download in bytes.
4141
*
4242
* @returns the file size in bytes, or -1 if called when updating to an AAB or if no new release
4343
* is available.

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/internal/InstallActivity.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ protected void onResume() {
4747
// Since we kick-off installation with FLAG_ACTIVITY_NEW_TASK (in a new task), we won't be able
4848
// to figure out if installation failed or was canceled.
4949
// If we re-enter InstallActivity after install is already kicked off, we can assume that either
50-
// installation failure or user canceled the install.
50+
// installation failure or tester canceled the install.
5151
if (installInProgress) {
5252
LogWrapper.getInstance()
5353
.e(

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/internal/SignInResultActivity.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public class SignInResultActivity extends AppCompatActivity {
2828
@Override
2929
public void onCreate(@NonNull Bundle savedInstanceBundle) {
3030
super.onCreate(savedInstanceBundle);
31-
LogWrapper.getInstance().v(TAG + "The User is signing in");
31+
LogWrapper.getInstance().v(TAG + "The tester is signing in");
3232
// While this does not appear to be achieving much, handling the redirect in this way
3333
// ensures that we can remove the browser tab from the back stack. See the documentation
3434
// on AuthorizationManagementActivity for more details.

0 commit comments

Comments
 (0)