Add some docs

mrclrchtr · Nov 15, 2023 · 4081bf2 · 4081bf2
1 parent c135e37
commit 4081bf2
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/buildSrc/src/main/kotlin/kotlin-conventions.gradle.kts b/buildSrc/src/main/kotlin/kotlin-conventions.gradle.kts
@@ -56,8 +56,16 @@ kotlin {
 
 detekt {
     ignoreFailures = false
+
+    // Applies the config files on top of detekt's default config file. `false` by default.
     buildUponDefaultConfig = true
+
+    // Define the detekt configuration(s) you want to use.
+    // Defaults to the default detekt configuration.
     config.setFrom("$rootDir/detekt.yml")
+
+    // Builds the AST in parallel. Rules are always executed in parallel.
+    // Can lead to speedups in larger projects. `false` by default.
     parallel = true
 }