From 1423b51ea8bb1dab824d40b0437ef8fa60e03842 Mon Sep 17 00:00:00 2001
From: Jonathan Cornaz <jonathan.cornaz@optravis.com>
Date: Fri, 2 Oct 2020 10:22:01 +0200
Subject: [PATCH] chore: Restrict number of allowed detekt issues to zero

---
 detekt-config.yml                                           | 3 ---
 .../com/github/jcornaz/kwik/generator/stdlib/Characters.kt  | 6 ++++++
 2 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/detekt-config.yml b/detekt-config.yml
index 85a7f70d..08a77cd3 100644
--- 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/generator/stdlib/src/commonMain/kotlin/com/github/jcornaz/kwik/generator/stdlib/Characters.kt b/generator/stdlib/src/commonMain/kotlin/com/github/jcornaz/kwik/generator/stdlib/Characters.kt
index 584b10b8..f9572ee1 100644
--- a/generator/stdlib/src/commonMain/kotlin/com/github/jcornaz/kwik/generator/stdlib/Characters.kt
+++ b/generator/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()