Add mention of kind-projector in doc · typelevel/skunk#416

(2 comments) (0 reactions) (0 assignees)Scala (1,656 stars) (172 forks)batch import

good first issue

Description

full example from https://github.com/tpolecat/skunk/blob/v0.0.24/modules/docs/src/main/paradox/tutorial/Command.md gives following compile errors

skunk-world/src/main/scala/CommandExample.scala:42:34
not found: type *
  def fromSession[F[_] : Bracket[*[_], Throwable]](s: Session[F]): PetService[F] =

skunk-world/src/main/scala/CommandExample.scala:42:24
cats.effect.Bracket[<error>,Throwable] does not take type parameters
  def fromSession[F[_] : Bracket[*[_], Throwable]](s: Session[F]): PetService[F] =

skunk-world/src/main/scala/CommandExample.scala:44:63
could not find implicit value for parameter F: cats.effect.BracketThrow[[x]F[x]] (Could not find an instance of Monad for [x]F[x])
      def insert(pet: Pet): F[Unit] = s.prepare(insertOne).use(_.execute(pet)).void

skunk-world/src/main/scala/CommandExample.scala:46:73
could not find implicit value for parameter F: cats.effect.BracketThrow[[x]F[x]] (Could not find an instance of Monad for [x]F[x])
      def insert(ps: List[Pet]): F[Unit] = s.prepare(insertMany(ps)).use(_.execute(ps)).void

skunk-world/src/main/scala/CommandExample.scala:79:16
value insert is not a member of Nothing
        _ <- s.insert(Pet("Bob", 12))

skunk-world/src/main/scala/CommandExample.scala:80:16
value insert is not a member of Nothing
        _ <- s.insert(beagles)

skunk-world/src/main/scala/CommandExample.scala:81:17
value selectAll is not a member of Nothing
        ps <- s.selectAll

Contributor guide

Tech stack: scala
Domain: documentationbackend
Issue type: documentation
Difficulty: 2
Estimated time: under 1 hour
Activity status: stale
Clarity: clear
Prerequisites: Scala basic project setup
Newbie friendliness: 90
Research direction: The issue is to add a mention of the kind projector compiler plugin in the documentation file located at modules/docs/src/main/paradox/tutorial/Command.md (as referenced in the issue). The doc should explain that to use the code examples, users need to enable the kind projector plugin in their build.sbt by adding `addCompilerPlugin("org.typelevel" % "kind projector" % "0.13.2" cross CrossVersion.full)`. If the user is using Scala 2.13 or 3, appropriate versions should be noted. The fix is a simple documentation update.