Skip to content
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

Merged
merged 2 commits into from Oct 21, 2017

Conversation

AlejandroME
Copy link
Contributor

Fixes #1962.

@codecov-io
Copy link

codecov-io commented Oct 20, 2017

Codecov Report

Merging #1985 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 882a673...82c1739. Read the comment docs.

@@ -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)
Copy link
Contributor

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? "

Copy link
Contributor Author

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).
Copy link
Contributor

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?

Copy link
Contributor Author

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.

Copy link
Contributor

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.

@kailuowang kailuowang merged commit 7b4814a into typelevel:master Oct 21, 2017
@kailuowang
Copy link
Contributor

Thanks very much @AlejandroME for this nice fix.

@AlejandroME AlejandroME deleted the lawTestingDocs branch October 21, 2017 22:21
kailuowang pushed a commit to kailuowang/cats that referenced this pull request Oct 23, 2017
* Links "LawTesting.md" in FAQ and TypeClasses pages

* Rewrites law testing title in FAQ
@kailuowang kailuowang added this to the 1.0.0-RC1 milestone Oct 31, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants