-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Links "LawTesting.md" in FAQ and TypeClasses pages #1985
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1985 +/- ##
=======================================
Coverage 96.21% 96.21%
=======================================
Files 272 272
Lines 4627 4627
Branches 115 112 -3
=======================================
Hits 4452 4452
Misses 175 175 Continue to review full report at Codecov.
|
docs/src/main/tut/faq.md
Outdated
@@ -22,6 +22,7 @@ position: 40 | |||
* [What does `macro Ops` do? What is `cats.macros.Ops`?](#machinist) | |||
* [What is `tailRecM`?](#tailrecm) | |||
* [What does this symbol mean?](#symbol) | |||
* [How can I test `laws`?](#law-testing) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A more specific way to say could be "how can I test instances against their type classes' laws? "
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfect!
@@ -221,6 +221,8 @@ val result = Monoid[Int].combine(sumLeft, sumRight) | |||
Cats provides laws for type classes via the `kernel-laws` and `laws` modules which makes law checking | |||
type class instances easy. | |||
|
|||
You can find out more about law testing [here](typeclasses/lawtesting.html). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry I should've caught this earlier. This link probably has an extra typeclasses in path?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kailuowang The path is good. I've tested it.
Without the typeclasses
prefix the URL formed is: /cats/lawtesting.html (which is broken). The original .md is placed in typeclasses/lawtesting.md.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh cool, thanks for testing it.
Thanks very much @AlejandroME for this nice fix. |
* Links "LawTesting.md" in FAQ and TypeClasses pages * Rewrites law testing title in FAQ
Fixes #1962.