Document evidence types and suppress their coverage

scalalandio · Apr 10, 2024 · b71778f · b71778f
1 parent 9cc0a6a
commit b71778f
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 0 deletions.
diff --git a/chimney/src/main/scala/io/scalaland/chimney/internal/runtime/IsCollection.scala b/chimney/src/main/scala/io/scalaland/chimney/internal/runtime/IsCollection.scala
@@ -2,6 +2,12 @@ package io.scalaland.chimney.internal.runtime
 
 import scala.annotation.{implicitNotFound, unused}
 
+// $COVERAGE-OFF$evidence used only within macro-erased expressions
+
+/** Allow us to provide `.everyItem` extension method only for the types where macros would actually handle it.
+  *
+  * @since 1.0.0
+  */
 @implicitNotFound(
   "Expected collection (type extending scala.Iterable which has scala.collection.compat.Factory instance), got ${C}"
 )

diff --git a/chimney/src/main/scala/io/scalaland/chimney/internal/runtime/IsEither.scala b/chimney/src/main/scala/io/scalaland/chimney/internal/runtime/IsEither.scala
@@ -2,6 +2,13 @@ package io.scalaland.chimney.internal.runtime
 
 import scala.annotation.implicitNotFound
 
+// $COVERAGE-OFF$evidence used only within macro-erased expressions
+
+/** Allow us to provide `.matchingLeft` and `.matchingRight` extension methods only for the types where macros would
+  * actually handle it.
+  *
+  * @since 1.0.0
+  */
 @implicitNotFound("Expected Either (type extending scala.Either), got ${E}")
 sealed trait IsEither[E] {
   type LeftValue

diff --git a/chimney/src/main/scala/io/scalaland/chimney/internal/runtime/IsMap.scala b/chimney/src/main/scala/io/scalaland/chimney/internal/runtime/IsMap.scala
@@ -2,6 +2,13 @@ package io.scalaland.chimney.internal.runtime
 
 import scala.annotation.{implicitNotFound, unused}
 
+// $COVERAGE-OFF$evidence used only within macro-erased expressions
+
+/** Allow us to provide `.everyMapKey` and `.everyMapValue` extension methods only for the types where macros would
+  * actually handle it.
+  *
+  * @since 1.0.0
+  */
 @implicitNotFound(
   "Expected map (type extending scala.collection.immutable.Map which has scala.collection.compat.Factory instance), got ${M}"
 )

diff --git a/chimney/src/main/scala/io/scalaland/chimney/internal/runtime/IsOption.scala b/chimney/src/main/scala/io/scalaland/chimney/internal/runtime/IsOption.scala
@@ -2,6 +2,12 @@ package io.scalaland.chimney.internal.runtime
 
 import scala.annotation.implicitNotFound
 
+// $COVERAGE-OFF$evidence used only within macro-erased expressions
+
+/** Allow us to provide `.matchingSome` extension method only for the types where macros would actually handle it.
+  *
+  * @since 1.0.0
+  */
 @implicitNotFound("Expected Option (type extending scala.Option), got ${O}")
 sealed trait IsOption[O] {
   type SomeValue