chore: Restrict number of allowed detekt issues to zero

jcornaz · Oct 2, 2020 · 1423b51 · 1423b51
1 parent 2e8b7a6
commit 1423b51
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/detekt-config.yml b/detekt-config.yml
@@ -1,6 +1,3 @@
-build:
-  maxIssues: 2
-
 comments:
   active: true
   excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt,**/examples/**"

diff --git a/...rator/stdlib/src/commonMain/kotlin/com/github/jcornaz/kwik/generator/stdlib/Characters.kt b/...rator/stdlib/src/commonMain/kotlin/com/github/jcornaz/kwik/generator/stdlib/Characters.kt
@@ -4,6 +4,12 @@ import com.github.jcornaz.kwik.generator.api.Generator
 import com.github.jcornaz.kwik.generator.api.withSamples
 import kotlin.random.Random
 
+/**
+ * Returns a generator of [Char]
+ *
+ * @param charset Set of character to be used
+ * @param exclude Characters to exclude
+ */
 fun Generator.Companion.characters(
     charset: Set<Char> = CharSets.printable,
     exclude: Set<Char> = emptySet()