Skip to content

Commit

Permalink
[Clean Up] annotations README.md (ankidroid#15633)
Browse files Browse the repository at this point in the history
* fix warning of unexpected end of file

* Update README.md

* Update README.md
  • Loading branch information
ro4i7 authored Feb 29, 2024
1 parent fc3f3bf commit a94f835
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions annotations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Rationale

`@Contract` annotations for Android methods allow the removal of tautotlogical lint checks.
`@Contract` annotations for Android methods allow the removal of tautological lint checks.

For example: if `TextUtils.isEmpty(str)` returns `false`, then `str` is non-null. `@Contract` allows us to specify this invariant to the linter, which reduces lint warnings and/or unnecessary code.

Expand All @@ -22,11 +22,11 @@ See: https://www.jetbrains.com/help/idea/contract-annotations.html

Annotations should now appear

## Modificiation Instructions
## Modification Instructions

* In Android Studio Settings: `jdk.table.xml`
* You can find the element under one of the `<jdk>` elements as a `file://` URL:
* Removing this line will allow the selection of another annotations root.
* You can find the element under one of the `<jdk>` elements as a `file://` URL:
* Removing this line will allow the selection of another annotation root.

Sample:
```xml
Expand All @@ -46,4 +46,4 @@ Sample:

It would be ideal if these could be set on a per-project basis. I haven't had the time to determine whether this is possible.

These annotations are not yet supported by our automated tooling.
These annotations are not yet supported by our automated tooling.

0 comments on commit a94f835

Please sign in to comment.