Fix inconsistency related to `--include-only` param in README.md - Githubissues

cortinico / ktfmt-gradle

A Gradle plugin to apply ktfmt to your builds, and reformat you Kotlin source code like a glimpse 🧹🐘

MIT License

149 stars 20 forks source link

Fix inconsistency related to `--include-only` param in README.md #283

Closed MartinNuc closed 4 months ago

MartinNuc commented 4 months ago

🚀 Description

There is an inconsistency in the readme for --include-only param where it says comma separated values, but in the example, there are colon-separated values. Somebody else raised it also in slack.

📄 Motivation and Context

improves clarity of the docs

🧪 How Has This Been Tested?

I didn't test this but I checked the source code and it supports both: https://github.com/cortinico/ktfmt-`gradle/blob/ecda8fb1ca3e1414f2337ae2de97340425cbc7f1/plugin-build/plugin/src/main/java/com/ncorti/ktfmt/gradle/tasks/IncludedFilesParser.kt#L9

📦 Types of changes

[x] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

✅ Checklist

[x] My code follows the code style of this project.
[x] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.