typelevel / typelevel/cats

Unusual EqLaws definition

Open
#4,514 4 comments 1 reaction 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

I found that EqLaws has an unusual definition:

https://github.com/typelevel/cats/blob/d40b88462529fead1ffe630415267d529df0cee5/kernel-laws/shared/src/main/scala/cats/kernel/laws/EqLaws.scala#L36-L37

Equivalency that I know doesn't have antisymmetry law, that is typically included in order.
I wonder where is the source of this kind of equivalency definition.

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

Start by reading kernel-laws/shared/src/main/scala/cats/kernel/laws/EqLaws.scala at lines 36-37 and the surrounding law definitions. Trace the rationale for including antisymmetry and compare it with the issue's stated equivalence definition. Done requires a maintainer-backed explanation or a decided correction, but the issue does not specify which change is wanted.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.