Skip to content

Commit

Permalink
Fix typos
Browse files Browse the repository at this point in the history
This PR fixes a few typos I spotted in the documentation of the project.

Fixes #4224

COPYBARA_INTEGRATE_REVIEW=#4224 from deining:fix-typos 25978d6
PiperOrigin-RevId: 604736232
  • Loading branch information
deining authored and Error Prone Team committed Feb 6, 2024
1 parent 618d488 commit 5f20325
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion docs/bugpattern/BindingToUnqualifiedCommonType.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/bugpattern/IsInstanceOfClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/bugpattern/OverridesGuiceInjectableMethod.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/bugpattern/RedundantOverride.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
9 changes: 5 additions & 4 deletions docs/bugpattern/StaticAssignmentOfThrowable.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/bugpattern/javadoc/InvalidInlineTag.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<pre>{@code ... }</pre>`:

```java
Expand Down

0 comments on commit 5f20325

Please sign in to comment.