typelevel / typelevel/cats

Something is wrong with the Writer documentation?

Open
#3,970 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
5.5k
Forks
1.2k
Avg merge
2d 10h
Merged PRs (30d)
5

Description

See here.

import cats.data.Writer
import scala.math.sqrt

val writer1: Writer[String, Double] = Writer.value(5.0).tell("Initial value ")

This fails with

diverging implicit expansion for type cats.kernel.Order[A]
starting with method catsKernelOrderForFunction0 in object Eq
val writer1: Writer[String, Double] = Writer.value(5.0).tell("Initial value ")

Still fails if I add the following, from the beginning of the docs page.

import cats.instances._

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 linked Writer documentation example and run the shown Scala snippet, including the suggested cats.instances._ import. Check why the example fails with the reported cats.kernel.Order implicit-expansion error; done means the documented example compiles and remains consistent with the surrounding Writer documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.