From 5f2032591a8bacb496e48a9a62a1616d18586e03 Mon Sep 17 00:00:00 2001 From: Andreas Deininger Date: Tue, 6 Feb 2024 12:53:41 -0800 Subject: [PATCH] Fix typos This PR fixes a few typos I spotted in the documentation of the project. Fixes #4224 COPYBARA_INTEGRATE_REVIEW=https://github.com/google/error-prone/pull/4224 from deining:fix-typos 25978d61f67cb0ca228c3fb006a2a6031fcbfb44 PiperOrigin-RevId: 604736232 --- .../google/errorprone/bugpatterns/ClassNewInstance.java | 2 +- docs/bugpattern/BindingToUnqualifiedCommonType.md | 2 +- docs/bugpattern/IsInstanceOfClass.md | 2 +- docs/bugpattern/OverridesGuiceInjectableMethod.md | 2 +- docs/bugpattern/RedundantOverride.md | 2 +- docs/bugpattern/StaticAssignmentOfThrowable.md | 9 +++++---- docs/bugpattern/javadoc/InvalidInlineTag.md | 2 +- 7 files changed, 11 insertions(+), 10 deletions(-) diff --git a/core/src/main/java/com/google/errorprone/bugpatterns/ClassNewInstance.java b/core/src/main/java/com/google/errorprone/bugpatterns/ClassNewInstance.java index dc20ff9181c..6d541da0d1b 100644 --- a/core/src/main/java/com/google/errorprone/bugpatterns/ClassNewInstance.java +++ b/core/src/main/java/com/google/errorprone/bugpatterns/ClassNewInstance.java @@ -83,7 +83,7 @@ public Description matchMethodInvocation(MethodInvocationTree tree, VisitorState return describeMatch(tree, fix.build()); } - // if the match occurrs inside the body of a try statement with existing catch clauses + // if the match occurs inside the body of a try statement with existing catch clauses // update or add a catch block to handle the new exceptions private static boolean fixExceptions(VisitorState state, SuggestedFix.Builder fix) { TryTree tryTree = null; diff --git a/docs/bugpattern/BindingToUnqualifiedCommonType.md b/docs/bugpattern/BindingToUnqualifiedCommonType.md index 3c8fdde6fe7..26d97a01310 100644 --- a/docs/bugpattern/BindingToUnqualifiedCommonType.md +++ b/docs/bugpattern/BindingToUnqualifiedCommonType.md @@ -1,6 +1,6 @@ Guice bindings are keyed by a pair of (optional Annotation, Type). -In most cirumstances, one doesn't need the annotation, as there's really just +In most circumstances, one doesn't need the annotation, as there's really just one active implementation: ```java diff --git a/docs/bugpattern/IsInstanceOfClass.md b/docs/bugpattern/IsInstanceOfClass.md index 2159a61da24..192b5b13d02 100644 --- a/docs/bugpattern/IsInstanceOfClass.md +++ b/docs/bugpattern/IsInstanceOfClass.md @@ -18,7 +18,7 @@ equal to `Class` (i.e. lhs is equal to `Class.class`). ``` To test if the type represented by a class literal is a subtype of the type -reprsented by some other class literal, `isAssignableFrom` should be used +represented by some other class literal, `isAssignableFrom` should be used instead: ```java diff --git a/docs/bugpattern/OverridesGuiceInjectableMethod.md b/docs/bugpattern/OverridesGuiceInjectableMethod.md index 3e56f97e968..41bd7878324 100644 --- a/docs/bugpattern/OverridesGuiceInjectableMethod.md +++ b/docs/bugpattern/OverridesGuiceInjectableMethod.md @@ -3,5 +3,5 @@ with `@com.google.inject.Inject`, Guice will inject it even if it itself is not annotated. This differs from the behavior of methods that override `@javax.inject.Inject` methods since according to the JSR-330 spec, a method that overrides a method annotated with `@javax.inject.Inject` will not be -injected unless it iself is annotated with `@Inject`. Because of this +injected unless it itself is annotated with `@Inject`. Because of this difference, it is recommended that you annotate this method explicitly. diff --git a/docs/bugpattern/RedundantOverride.md b/docs/bugpattern/RedundantOverride.md index 641ccd63571..de88b37bcbf 100644 --- a/docs/bugpattern/RedundantOverride.md +++ b/docs/bugpattern/RedundantOverride.md @@ -1,5 +1,5 @@ An override of a method that delegates its implementation to the super method is -redudant, and can be removed. +redundant, and can be removed. For example, the `equals` method in the following class implementation can be deleted. diff --git a/docs/bugpattern/StaticAssignmentOfThrowable.md b/docs/bugpattern/StaticAssignmentOfThrowable.md index f1894d2cdf8..813f77581ca 100644 --- a/docs/bugpattern/StaticAssignmentOfThrowable.md +++ b/docs/bugpattern/StaticAssignmentOfThrowable.md @@ -1,8 +1,9 @@ The problem we're trying to prevent is unhelpful stack traces that don't contain -information about where the Exception was thrown from. This probem can sometimes -arise when an attempt is being made to cache or reuse a Throwable (often, a -particular Exception). In this case, consider whether this is really is -necessary: it often isn't. Could a Throwable simply be instantiated when needed? +information about where the Exception was thrown from. This problem can +sometimes arise when an attempt is being made to cache or reuse a Throwable +(often, a particular Exception). In this case, consider whether this is really +is necessary: it often isn't. Could a Throwable simply be instantiated when +needed? ``` {.bad} // this always has the same stack trace diff --git a/docs/bugpattern/javadoc/InvalidInlineTag.md b/docs/bugpattern/javadoc/InvalidInlineTag.md index 9cba566ed68..135348ec172 100644 --- a/docs/bugpattern/javadoc/InvalidInlineTag.md +++ b/docs/bugpattern/javadoc/InvalidInlineTag.md @@ -21,7 +21,7 @@ int twoTimes(int n) { } ``` -If the `@` symbol occurrs inside a code excerpt, the fix is to escape the code +If the `@` symbol occurs inside a code excerpt, the fix is to escape the code excerpt using `
{@code ... }
`: ```java