Add a bit of documentation

creativescala · Jul 4, 2024 · 67766fd · 67766fd
1 parent 736ac50
commit 67766fd
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/core/shared/src/main/scala/krop/route/ParamParseFailure.scala b/core/shared/src/main/scala/krop/route/ParamParseFailure.scala
@@ -16,4 +16,9 @@
 
 package krop.route
 
+/** Represents a failure of a Param to parse a value
+  *
+  * Value is the value that failed to parse. Description is a description of the
+  * Param.
+  */
 final case class ParamParseFailure(value: String, description: String)