typelevel / typelevel/skunk

Add mention of kind-projector in doc

Open
#416 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
Scala
Stars
1.7k
Forks
175
Avg merge
5d 14h
Merged PRs (30d)
9

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the full example in modules/docs/src/main/paradox/tutorial/Command.md, linked from the issue, and compare its Scala type-lambda syntax with the reported errors in skunk-world/src/main/scala/CommandExample.scala. Update the documentation to mention kind-projector and verify that the example's compilation issue is explained.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.