Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add package statement to Annotator expected output
  • Loading branch information
nimakarimipour authored Nov 19, 2024
1 parent 98163b2 commit c39057e
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ The final output of Annotator is a source code that passes NullAway checks with
In the code below, `NullAway` reports five warnings.

```java
package com.example;
class Test{
Object f1 = null; // warning: assigning @Nullable expression to @NonNull field
Object f2 = null; // warning: assigning @Nullable expression to @NonNull field
Expand Down Expand Up @@ -49,6 +50,7 @@ For unresolved errors, suppression annotations are injected.
The output below shows the result of running `Annotator` on the code above.

```java
package com.example;
import javax.annotation.Nullable; // added by Annotator
import org.jspecify.annotations.NullUnmarked; // added by Annotator

Expand Down

0 comments on commit c39057e

Please sign in to comment.