From a94f8355d525f0c2c7fe6f3dc7e2c8ca189fbfd2 Mon Sep 17 00:00:00 2001 From: Rohit Raj <88114930+ro4i7@users.noreply.github.com> Date: Thu, 29 Feb 2024 23:31:46 +0530 Subject: [PATCH] [Clean Up] annotations README.md (#15633) * fix warning of unexpected end of file * Update README.md * Update README.md --- annotations/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/annotations/README.md b/annotations/README.md index 6a4aaa54b041..a825c5b604d0 100644 --- a/annotations/README.md +++ b/annotations/README.md @@ -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. @@ -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 `` 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 `` elements as a `file://` URL: +* Removing this line will allow the selection of another annotation root. Sample: ```xml @@ -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. \ No newline at end of file +These annotations are not yet supported by our automated tooling.