detekt.

AdamMc331 · Apr 22, 2022 · a111011 · a111011
1 parent 2743b8d
commit a111011
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/config/detekt/detekt.yml b/config/detekt/detekt.yml
@@ -618,7 +618,7 @@ style:
   MagicNumber:
     active: true
     excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
-    ignoreNumbers: ['-1', '0', '1', '2', '10']
+    ignoreNumbers: ['-1', '0', '1', '2', '3', '10']
     ignoreHashCodeFunction: true
     ignorePropertyDeclaration: false
     ignoreLocalVariableDeclaration: false

diff --git a/...ain/kotlin/com/adammcneilly/pocketleague/shared/displaymodels/EventSummaryDisplayModel.kt b/...ain/kotlin/com/adammcneilly/pocketleague/shared/displaymodels/EventSummaryDisplayModel.kt
@@ -17,6 +17,9 @@ data class EventSummaryDisplayModel(
     }
 }
 
+/**
+ * Converts an [Event] entity to the user friendly [EventSummaryDisplayModel].
+ */
 fun Event.toSummaryDisplayModel(
     dateTimeFormatter: DateTimeFormatter = DateTimeFormatter(),
 ): EventSummaryDisplayModel {