Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating readme #298

Merged
merged 1 commit into from
Sep 16, 2020
Merged

Updating readme #298

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@
[![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/)
[![Chat on Telegram](https://img.shields.io/badge/Chat%20on-Telegram-brightgreen.svg)](https://t.me/joinchat/AAAAAFDg-ipuZFGyBGPPeg)

## (!) See [diKTat codestyle](info/diktat-kotlin-coding-style-guide-en.md) first. This is a formal code style used by this linter.
## (!) Also see [the list of all rules supported by diKTat](info/available-rules.md).
## (!) Have a look at [maven and gradle examples](https://github.com/akuleshov7/diktat-examples) of usage diKTat with plugins.
### (!) See [diKTat codestyle](info/diktat-kotlin-coding-style-guide-en.md) first.
### (!) Also see [the list of all supported rules](info/available-rules.md).
### (!) Have a look at [maven and gradle examples](https://github.com/akuleshov7/diktat-examples).
### (!) Check and try diktat/ktlint [online demo](https://ktlint-demo.herokuapp.com)

DiKTat is a collection of [Kotlin](https://kotlinlang.org/) code style rules implemented
as AST visitors on top of [KTlint](https://ktlint.github.io/).
Expand Down Expand Up @@ -197,7 +198,7 @@ See default configuration in [diktat-analysis.yml](diktat-rules/src/main/resourc
Also see [the list of all rules supported by diKTat](info/available-rules.md).

## Suppress warnings on individual code blocks
In addition to enabling/disabling warning globally via config file, you can suppress warnings by adding `@Suppress` annotation on individual code blocks
In addition to enabling/disabling warning globally via config file (`enable = false`), you can suppress warnings by adding `@Suppress` annotation on individual code blocks

For example:

Expand Down