From 1e0b05bc45e802a30d241e518b8ac207f37666f9 Mon Sep 17 00:00:00 2001
From: Ruslans Tarasovs <ruslan@tarasovs.com>
Date: Mon, 15 Jan 2024 16:16:57 +0200
Subject: [PATCH] Add scaladoc for SerialRef

---
 build.sbt                                                   | 2 ++
 .../scala/com/evolutiongaming/catshelper/SerialRef.scala    | 6 ++++++
 2 files changed, 8 insertions(+)

diff --git a/build.sbt b/build.sbt
index 9d84eab2..a700e6c9 100644
--- a/build.sbt
+++ b/build.sbt
@@ -25,6 +25,8 @@ inThisBuild(Seq(
   scalaVersion := crossScalaVersions.value.head,
 
   publishTo := Some(Resolver.evolutionReleases),
+
+  autoAPIMappings := true,
 ))
 
 // Settings that can't be defined on a higher level go here.
diff --git a/core/src/main/scala/com/evolutiongaming/catshelper/SerialRef.scala b/core/src/main/scala/com/evolutiongaming/catshelper/SerialRef.scala
index a2a307be..f440f9a9 100644
--- a/core/src/main/scala/com/evolutiongaming/catshelper/SerialRef.scala
+++ b/core/src/main/scala/com/evolutiongaming/catshelper/SerialRef.scala
@@ -6,6 +6,12 @@ import cats.effect.std.Semaphore
 import cats.implicits._
 import cats.~>
 
+/** Similar to [[cats.effect.std.AtomicCell]].
+  * 
+  * [[SerialRef]] was created when [[cats.effect.std.AtomicCell]] did not exist
+  * yet, and is kept for backwards compatibility purposes and ability to use
+  * the same code for both Cats Effect 2 and Cats Effect 3.
+  */
 trait SerialRef[F[_], A] {
 
   def get: F[A]