Skip to content

Commit

Permalink
Merge pull request #2596 from pinterest/2594-documentation
Browse files Browse the repository at this point in the history
Fix reference in documentation
  • Loading branch information
paul-dingemans authored Mar 7, 2024
2 parents 5717063 + 2953f15 commit 2e4b19c
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion documentation/release-latest/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ Yes, it is possible to use KtLint to directly format the code generated with Kot
To do so, you must include the dependencies `com.pinterest.ktlint:ktlint-core` and `com.pinterest.ktlint:ktlint-ruleset-standard` in your Gradle/Maven project.

!!! warning
Do not include the dependency `com.pinterest:ktlint` as that would import the entire ktlint project including unwanted dependencies. Besides a much bigger artifact, it might also result in problems regarding logging.
Do not include the dependency `com.pinterest.ktlint:ktlint-cli` as that would import the entire ktlint project including unwanted dependencies. Besides a much bigger artifact, it might also result in problems regarding logging.

To format the output of KotlinPoet with KtLint, you can use the following snippet:

Expand Down
2 changes: 1 addition & 1 deletion documentation/snapshot/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ Yes, it is possible to use KtLint to directly format the code generated with Kot
To do so, you must include the dependencies `com.pinterest.ktlint:ktlint-core` and `com.pinterest.ktlint:ktlint-ruleset-standard` in your Gradle/Maven project.

!!! warning
Do not include the dependency `com.pinterest:ktlint` as that would import the entire ktlint project including unwanted dependencies. Besides a much bigger artifact, it might also result in problems regarding logging.
Do not include the dependency `com.pinterest.ktlint:ktlint-cli` as that would import the entire ktlint project including unwanted dependencies. Besides a much bigger artifact, it might also result in problems regarding logging.

To format the output of KotlinPoet with KtLint, you can use the following snippet:

Expand Down

0 comments on commit 2e4b19c

Please sign in to comment.