Clarify task exclude documentation

Address #208.
jeremymailen · Jul 23, 2021 · 94a1317 · 94a1317
1 parent 25b89d3
commit 94a1317
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -214,7 +214,7 @@ import org.jmailen.gradle.kotlinter.tasks.LintTask
 
 tasks {
     "lintKotlinMain"(LintTask::class) {
-        exclude("**/*Generated.kt")
+        exclude("com/example/**/generated/*.kt")
     }
 }
 ```
@@ -226,12 +226,14 @@ tasks {
 
 ```groovy
 lintKotlinMain {
-    exclude '**/*Generated.kt'
+    exclude 'com/example/**/generated/*.kt'
 }
 ```
 
 </details>
 
+Note that exclude paths are relative to the package root.
+
 ### Custom Tasks
 
 If you aren't using autoconfiguration from a supported plugin or otherwise need to handle additional source code, you can create custom tasks: