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.

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

Update wrong task name in "Tasks Added" in README #611

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dxts
Copy link

@dxts dxts commented Sep 27, 2022

In the README, Tasks Added list includes the task ktlint[source set name]SourceSetCheck twice.
The second listing of the task should actually be named ktlint[source set name]SourceSetFormat.

@@ -471,7 +471,7 @@ Then for each `SourceSet` plugin adds following tasks:
- `ktlint[source set name]SourceSetCheck` - generates reports and prints issues into Gradle console based on lint check found errors.
This task execution depends on `loadKtlintReporters` and `runKtlintCheckOver[source set name]SourceSet` tasks execution outputs
- `runKtlintFormatOver[source set name]SourceSet` - tries to format according to the code style every Kotlin file in given `SourceSet`
- `ktlint[source set name]SourceSetCheck` - generates reports and prints issues into Gradle console based on found non-formattable errors.
- `ktlint[source set name]SourceSetFormat` - generates reports and prints issues into Gradle console based on found non-formattable errors.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch! I think the description should be updated as well to indicate that the source files will be formatted.

In `Tasks Added` list, task `ktlint[source set name]SourceSetFormat` was wrongly named as `ktlint[source set name]SourceSetCheck`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants