fix docs

cb372 · Nov 7, 2021 · adfa4dd · adfa4dd
1 parent 91706ea
commit adfa4dd
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 13 deletions.
diff --git a/modules/docs/src/main/mdoc/docs/cache-implementations.md b/modules/docs/src/main/mdoc/docs/cache-implementations.md
@@ -21,7 +21,7 @@ import scalacache.memcached._
 import scalacache.serialization.binary._
 import cats.effect.IO
 
-implicit val memcachedCache: Cache[IO, String] = MemcachedCache("localhost:11211")
+implicit val memcachedCache: Cache[IO, String, String] = MemcachedCache("localhost:11211")
 ```
 
 or provide your own Memcached client, like this:
@@ -36,7 +36,7 @@ val memcachedClient = new MemcachedClient(
   new BinaryConnectionFactory(), 
   AddrUtil.getAddresses("localhost:11211")
 )
-implicit val customisedMemcachedCache: Cache[IO, String] = MemcachedCache(memcachedClient)
+implicit val customisedMemcachedCache: Cache[IO, String, String] = MemcachedCache(memcachedClient)
 ```
 
 #### Keys
@@ -65,7 +65,7 @@ import scalacache.redis._
 import scalacache.serialization.binary._
 import cats.effect.IO
 
-implicit val redisCache: Cache[IO, String] = RedisCache("host1", 6379)
+implicit val redisCache: Cache[IO, String, String] = RedisCache("host1", 6379)
 ```
 
 or provide your own [Jedis](https://github.com/xetorthio/jedis) client, like this:
@@ -78,7 +78,7 @@ import _root_.redis.clients.jedis._
 import cats.effect.IO
 
 val jedisPool = new JedisPool("localhost", 6379)
-implicit val customisedRedisCache: Cache[IO, String] = RedisCache(jedisPool)
+implicit val customisedRedisCache: Cache[IO, String, String] = RedisCache(jedisPool)
 ```
 
 ScalaCache also supports [sharded Redis](https://github.com/xetorthio/jedis/wiki/AdvancedUsage#shardedjedis) and [Redis Sentinel](http://redis.io/topics/sentinel). Just create a `ShardedRedisCache` or `SentinelRedisCache` respectively.
@@ -101,7 +101,7 @@ import cats.effect.unsafe.implicits.global
 
 implicit val clock: Clock[IO] = Clock[IO]
 
-implicit val caffeineCache: Cache[IO, String] = CaffeineCache[IO, String].unsafeRunSync()
+implicit val caffeineCache: Cache[IO, String, String] = CaffeineCache[IO, String, String].unsafeRunSync()
 ```
 
 This will build a Caffeine cache with all the default settings. If you want to customize your Caffeine cache, then build it yourself and pass it to `CaffeineCache` like this:
@@ -114,7 +114,7 @@ import cats.effect.IO
 import cats.effect.unsafe.implicits.global
 
 val underlyingCaffeineCache = Caffeine.newBuilder().maximumSize(10000L).build[String, Entry[String]]
-implicit val customisedCaffeineCache: Cache[IO, String] = CaffeineCache(underlyingCaffeineCache)
+implicit val customisedCaffeineCache: Cache[IO, String, String] = CaffeineCache(underlyingCaffeineCache)
 ```
 
 ```scala mdoc:invisible

diff --git a/modules/docs/src/main/mdoc/docs/flags.md b/modules/docs/src/main/mdoc/docs/flags.md
@@ -29,7 +29,7 @@ import cats.effect.unsafe.implicits.global
 
 final case class Cat(id: Int, name: String, colour: String)
 
-implicit val catsCache: Cache[IO, Cat] = MemcachedCache("localhost:11211")
+implicit val catsCache: Cache[IO, String, Cat] = MemcachedCache("localhost:11211")
 
 def getCatWithFlags(id: Int)(implicit flags: Flags): Cat = memoize(None) {
   // Do DB lookup here...

diff --git a/modules/docs/src/main/mdoc/docs/index.md b/modules/docs/src/main/mdoc/docs/index.md
@@ -32,7 +32,7 @@ import scalacache.serialization.binary._
 
 final case class Cat(id: Int, name: String, colour: String)
 
-implicit val catsCache: Cache[IO, Cat] = MemcachedCache("localhost:11211")
+implicit val catsCache: Cache[IO, String, Cat] = MemcachedCache("localhost:11211")
 ```
 
 Note that we made the cache `implicit` so that the ScalaCache API can find it.
@@ -57,7 +57,7 @@ get("eric")
 remove("doraemon")
 
 // Flush the cache
-removeAll[Cat]
+removeAll[String, Cat]
 
 // Wrap any block with caching: if the key is not present in the cache,
 // the block will be executed and the value will be cached and returned
@@ -73,9 +73,6 @@ cachingF("benjamin")(ttl = None) {
     Cat(2, "Benjamin", "ginger")
   }
 }
-
-// You can also pass multiple parts to be combined into one key
-put("foo", 123, "bar")(ericTheCat) // Will be cached with key "foo:123:bar"
 ```
 
 ```scala mdoc:invisible

diff --git a/modules/docs/src/main/mdoc/docs/memoization.md b/modules/docs/src/main/mdoc/docs/memoization.md
@@ -17,7 +17,7 @@ import cats.effect.IO
 
 final case class Cat(id: Int, name: String, colour: String)
 
-implicit val catsCache: Cache[IO, Cat] = MemcachedCache("localhost:11211")
+implicit val catsCache: Cache[IO, String, Cat] = MemcachedCache("localhost:11211")
 
 def getCat(id: Int): IO[Cat] = memoize(Some(10.seconds)) {
   // Retrieve data from a remote API here ...