Add a Developer-Comment regarding an unused parameter.

typelevel · Dec 22, 2019 · 424f10a · 424f10a
1 parent b0c8121
commit 424f10a
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/core/src/main/scala/cats/data/Validated.scala b/core/src/main/scala/cats/data/Validated.scala
@@ -813,6 +813,8 @@ object Validated extends ValidatedInstances with ValidatedFunctions with Validat
    * Uses the [[http://typelevel.org/cats/guidelines.html#partially-applied-type-params Partially Applied Type Params technique]] for ergonomics.
    */
   final private[data] class CatchOnlyPartiallyApplied[T](private val dummy: Boolean = true) extends AnyVal {
+    /* Note: the NT parameter is not referenced at runtime, but serves a compile-time role.
+     * See https://github.com/typelevel/cats/pull/1867/files#r138381991 for details. */
     def apply[A](f: => A)(implicit T: ClassTag[T], NT: NotNull[T]): Validated[T, A] =
       try {
         valid(f)