Merge pull request #575 from cb372/fix-main

.github/workflows/ci.yml

@@ -27,7 +27,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        scala: [2.13.3, 2.12.12]
+        scala: [2.13.6, 2.12.14]
         java: [[email protected]]
     runs-on: ${{ matrix.os }}
     steps:
@@ -87,7 +87,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        scala: [2.13.3]
+        scala: [2.13.6]
         java: [[email protected]]
     runs-on: ${{ matrix.os }}
     steps:
@@ -113,22 +113,22 @@ jobs:
             ~/Library/Caches/Coursier/v1
           key: ${{ runner.os }}-sbt-cache-v2-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('project/build.properties') }}
 
-      - name: Download target directories (2.13.3)
+      - name: Download target directories (2.13.6)
         uses: actions/download-artifact@v2
         with:
-          name: target-${{ matrix.os }}-2.13.3-${{ matrix.java }}
+          name: target-${{ matrix.os }}-2.13.6-${{ matrix.java }}
 
-      - name: Inflate target directories (2.13.3)
+      - name: Inflate target directories (2.13.6)
         run: |
           tar xf targets.tar
           rm targets.tar
 
-      - name: Download target directories (2.12.12)
+      - name: Download target directories (2.12.14)
         uses: actions/download-artifact@v2
         with:
-          name: target-${{ matrix.os }}-2.12.12-${{ matrix.java }}
+          name: target-${{ matrix.os }}-2.12.14-${{ matrix.java }}
 
-      - name: Inflate target directories (2.12.12)
+      - name: Inflate target directories (2.12.14)
         run: |
           tar xf targets.tar
           rm targets.tar

build.sbt

@@ -164,8 +164,8 @@ lazy val mavenSettings = Seq(
   }
 )
 
-val Scala213 = "2.13.3"
-val Scala212 = "2.12.12"
+val Scala213 = "2.13.6"
+val Scala212 = "2.12.14"
 val Jdk11 = "[email protected]"
 
 ThisBuild / scalaVersion := Scala213

modules/docs/src/main/mdoc/docs/memoization.md

@@ -19,9 +19,7 @@ final case class Cat(id: Int, name: String, colour: String)
 
 implicit val catsCache: Cache[IO, Cat] = MemcachedCache("localhost:11211")
 
-// You wouldn't normally need to specify the type params for memoize.
-// This is an artifact of the way this README is generated using tut.
-def getCat(id: Int): IO[Cat] = memoize[IO, Cat](Some(10.seconds)) {
+def getCat(id: Int): IO[Cat] = memoize(Some(10.seconds)) {
   // Retrieve data from a remote API here ...
   Cat(id, s"cat ${id}", "black")
 }
@@ -35,7 +33,7 @@ The next time you call the method with the same arguments the result will be ret
 If the result of your block is wrapped in an effect container, use `memoizeF`:
 
 ```scala mdoc
-def getCatF(id: Int): IO[Cat] = memoizeF[IO, Cat](Some(10.seconds)) {
+def getCatF(id: Int): IO[Cat] = memoizeF(Some(10.seconds)) {
   IO {
     // Retrieve data from a remote API here ...
     Cat(id, s"cat ${id}", "black")
@@ -58,12 +56,13 @@ The cache key is built automatically from the class name, the name of the enclos
 For example, given the following method:
 
 ```scala
-package foo
 
 object Bar {
-  def baz(a: Int, b: String)(c: String): Int = memoizeSync(None) {
-    // Reticulating splines...   
-    123
+  def baz(a: Int, b: String)(c: String): Int = memoizeF(None) {
+    IO {
+      // Reticulating splines...
+      123
+    }
   }
 }
 ```
@@ -84,15 +83,15 @@ If your memoized method is inside a class, rather than an object, then the metho
 
 For example, if your code looks like this:
 
-```scala 
+```scala
 package foo
 
 class Bar(a: Int) {
 
   def baz(b: Int): Int = memoizeSync(None) {
     a + b
   }
-  
+
 }
 ```
 
@@ -106,7 +105,7 @@ implicit val cacheConfig = CacheConfig(
 
 Doing this will ensure that both the constructor arguments and the method arguments are included in the cache key:
 
-```scala 
+```scala
 new Bar(10).baz(42) // cached as "foo.Bar(10).baz(42)" -> 52
 new Bar(20).baz(42) // cached as "foo.Bar(20).baz(42)" -> 62
 ```
@@ -129,5 +128,5 @@ will only include the `userId` argument's value in its cache keys.
 import cats.effect.unsafe.implicits.global
 for (cache <- List(catsCache)) {
   cache.close.unsafeRunSync()
-} 
+}
 ```

project/build.properties

@@ -1 +1 @@
-sbt.version=1.4.9
+sbt.version=1.5.5

project/plugins.sbt

@@ -1,5 +1,5 @@
 addSbtPlugin("pl.project13.scala" % "sbt-jmh"            % "0.4.0")
-addSbtPlugin("com.47deg"          % "sbt-microsites"     % "1.1.5")
+addSbtPlugin("com.47deg"          % "sbt-microsites"     % "1.3.4")
 addSbtPlugin("org.scalameta"      % "sbt-scalafmt"       % "2.4.2")
 addSbtPlugin("org.scoverage"      % "sbt-scoverage"      % "1.6.1")
 addSbtPlugin("org.scalameta"      % "sbt-mdoc"           % "2.2.20")