From 67766fd4ea154c94560b3a9ce7622271fdfd42ef Mon Sep 17 00:00:00 2001
From: Noel Welsh <noel@noelwelsh.com>
Date: Thu, 4 Jul 2024 11:49:36 +0100
Subject: [PATCH] Add a bit of documentation

---
 .../shared/src/main/scala/krop/route/ParamParseFailure.scala | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/core/shared/src/main/scala/krop/route/ParamParseFailure.scala b/core/shared/src/main/scala/krop/route/ParamParseFailure.scala
index c5a698a..acb7597 100644
--- 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)