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

Law testing documentation improvement #3068

Closed
miklos-martin opened this issue Sep 17, 2019 · 2 comments
Closed

Law testing documentation improvement #3068

miklos-martin opened this issue Sep 17, 2019 · 2 comments

Comments

@miklos-martin
Copy link
Contributor

miklos-martin commented Sep 17, 2019

Hi,

First of all, thank you all for your amazing work on cats.

I have recently upgraded to 2.0 and I had a semi-hard time figuring out how to make my tests compile again. Previously I have been using CatsSuite from cats-testkit. If I understand correctly, my tests broke because of 9ef3af0.

I had some trouble following the Laws Testing docs and I think it would be nice to mention there what additional dependencies one will need if they are using scalatest, or specs2 (I'm using scalatest and I needed to add a snapshot version of it to have org.scalatest.funsuite.AnyFunSuite and a milestone release ofdiscipline-scalatest in addition to cats-laws to have org.typelevel.discipline.scalatest.Discipline).

I could send a PR if you like, what do you think?

@kailuowang
Copy link
Contributor

Sorry about the inconveniences, it's an oversight on our part, I did update the doc to point to the new way to use Catsuite, but we didn't publish the website, which I will do shortly. In the meantime, I think it's a good idea to mention dependency needed if you are not using Catsuite: a milestone release of discipline-scalatest in addition to cats-laws. A PR will be great!

@miklos-martin
Copy link
Contributor Author

Fixed in #3072, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants