diff --git a/project/CI.scala b/project/CI.scala index 5e42c26114..71e849267e 100644 --- a/project/CI.scala +++ b/project/CI.scala @@ -20,6 +20,7 @@ sealed abstract class CI( jsEnv: Option[JSEnv], testCommands: List[String], mimaReport: Boolean, + scaladoc: Boolean, suffixCommands: List[String]) { override val toString: String = { @@ -34,7 +35,8 @@ sealed abstract class CI( "clean" ) ++ testCommands ++ List( jsEnv.fold("")(_ => s"set Global / useJSEnv := JSEnv.NodeJS"), - if (mimaReport) "mimaReportBinaryIssues" else "" + if (mimaReport) "mimaReportBinaryIssues" else "", + if (scaladoc) "doc" else "" )).filter(_.nonEmpty) ++ suffixCommands commands.mkString("; ", "; ", "") @@ -49,7 +51,9 @@ object CI { jsEnv = None, testCommands = List("test"), mimaReport = true, - suffixCommands = List("root/unidoc", "exampleJVM/compile")) + scaladoc = true, + suffixCommands = List("root/unidoc", "exampleJVM/compile") + ) case object JS extends CI( @@ -58,6 +62,7 @@ object CI { jsEnv = Some(JSEnv.NodeJS), testCommands = List("test"), mimaReport = true, + scaladoc = true, suffixCommands = List("exampleJS/compile") ) @@ -68,6 +73,7 @@ object CI { jsEnv = None, testCommands = List("test"), mimaReport = true, + scaladoc = true, suffixCommands = List("exampleNative/compile") ) @@ -84,6 +90,7 @@ object CI { "testOnly *.SecureRandomSpec" ), mimaReport = false, + scaladoc = false, suffixCommands = List() ) @@ -101,6 +108,7 @@ object CI { "testOnly *.SecureRandomSpec" ), mimaReport = false, + scaladoc = false, suffixCommands = List() ) diff --git a/std/shared/src/main/scala/cats/effect/std/MapRef.scala b/std/shared/src/main/scala/cats/effect/std/MapRef.scala index 7459f14cb5..7689560c42 100644 --- a/std/shared/src/main/scala/cats/effect/std/MapRef.scala +++ b/std/shared/src/main/scala/cats/effect/std/MapRef.scala @@ -45,8 +45,9 @@ trait MapRef[F[_], K, V] extends Function1[K, Ref[F, V]] { object MapRef extends MapRefCompanionPlatform { /** - * Default constructor for [[MapRef]]. If [[Sync]] is available, it will delegate to - * [[ofConcurrentHashMap]], otherwise it will fallback to [[ofShardedImmutableMap]]. + * Default constructor for [[MapRef]]. If [[cats.effect.kernel.Sync]] is available, it will + * delegate to [[ofConcurrentHashMap]], otherwise it will fallback to + * [[ofShardedImmutableMap]]. */ def apply[F[_]: Concurrent, K, V]: F[MapRef[F, K, Option[V]]] = { Concurrent[F] match {