make NonEmptyMapImpl

typelevel · Jun 11, 2022 · e9abf24 · e9abf24
1 parent 9d83ecc
commit e9abf24
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/core/src/main/scala/cats/data/NonEmptyMapImpl.scala b/core/src/main/scala/cats/data/NonEmptyMapImpl.scala
@@ -26,7 +26,14 @@ import cats.kernel._
 
 import scala.collection.immutable._
 
-private[data] object NonEmptyMapImpl extends NonEmptyMapInstances with Newtype2 {
+/**
+ * Actual implementation for [[cats.data.NonEmptyMap]]
+ *
+ * @note This object is kept public for the sake of binary compatibility only
+ *       and therefore is subject to changes in future versions of Cats.
+ *       Do not use directly - use [[cats.data.NonEmptyMap]] instead.
+ */
+object NonEmptyMapImpl extends NonEmptyMapInstances with Newtype2 {
 
   private[data] def create[K, A](m: SortedMap[K, A]): Type[K, A] =
     m.asInstanceOf[Type[K, A]]