Skip to content

Commit

Permalink
docs: fix some comments (#3233)
Browse files Browse the repository at this point in the history
Signed-off-by: longxiangqiao <longxiangqiao@qq.com>
  • Loading branch information
longxiangqiao committed Jun 9, 2024
1 parent 4f73a74 commit cbee82f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/CI-Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
If you see any of the PR checks failing (❌) go to [Actions](https://github.com/Ivy-Apps/ivy-wallet/actions) and find it there. Or simply click "Details" next to the failed check and explore the logs to see why it has failed.

## Detekt
[Detekt](https://detekt.dev/) is a static code analyzer for Kotlin that we use to enforce code readibility and good practices.
[Detekt](https://detekt.dev/) is a static code analyzer for Kotlin that we use to enforce code readability and good practices.

**To run Detekt locally:**
```
./gradlew detekt
```

If the Detekt errors are caused by a legacy code, you can suppress them using a basline.
If the Detekt errors are caused by a legacy code, you can suppress them using a baseline.

**Suppress Detekt** (only if you're sure that Detekt is wrong)

Expand All @@ -36,7 +36,7 @@ We use the [standard Android Lint](https://developer.android.com/studio/write/li
./scripts/lint.sh
```

If the Lint errors are caused by a legacy code, you can suppress them using a basline.
If the Lint errors are caused by a legacy code, you can suppress them using a baseline.

**Suppress Lint** (only if you're sure that Lint is wrong)

Expand Down
2 changes: 1 addition & 1 deletion docs/Guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,5 @@ To get started read:
## References

- **[Yoda Style Architecture guidelines](./archive/Yoda-Style-Architecture.md)**
- **[Adnroid Developers - Guide to app architecture](https://developer.android.com/topic/architecture)**
- **[Android Developers - Guide to app architecture](https://developer.android.com/topic/architecture)**
- **[The Grug Brained Developer](https://grugbrain.dev/)**

0 comments on commit cbee82f

Please sign in to comment.