typelevel / typelevel/kind-projector

Doc confusion: no instance of the proposed Functor in "type lambda gotchas"

Open
#280 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
923
Forks
75
Avg merge
6h 5m
Merged PRs (30d)
1

Description

In Type Lambda gotchas:

In these cases you should prefer the lambda syntax, which would be written as:

Functor[Lambda[a => Future[List[a]]]]

The documentation doesn't explicitly refer to Cats' Functor, but most people are going to assume that, and Cats provides no such functor out of the box.

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

Open the Type Lambda gotchas section and review the quoted Functor example. Clarify which Functor is intended, or that no instance is provided out of the box, so the example does not imply that Cats supplies it; the section is done when this ambiguity is removed.

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
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.