Add a Developer-Comment regarding an unused parameter.

typelevel · Dec 21, 2019 · 4334003 · 4334003
1 parent b0c8121
commit 4334003
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
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)

diff --git a/tests/src/test/scala/cats/tests/NonEmptyMapSuite.scala b/tests/src/test/scala/cats/tests/NonEmptyMapSuite.scala
@@ -227,7 +227,7 @@ class NonEmptyMapSuite extends CatsSuite {
   }
 
   test("NonEmptyMap#updateWith should not act when key is missing") {
-    val single = NonEmptyMap[String, Int](("here", 1), SortedMap())
+    val single = NonEmptyMap[String, Int](("here", 1), SortedMap())(null)
     single.lookup("notHere") should ===(single.updateWith("notHere")(_ => 1).lookup("notHere"))
   }