Add doctests (excellent first-time issue)

[kailuowang]

Doctests are a great way to provide compilable and testable example code for scaladoc. We should cover as many methods with doctests as possible. Here is an example of PR adding doctests. Note that to test the doctests run sbt coreJVM/test This issue encompasses the effort of adding more doctest coverage to our type classes and data types. It would be a great first-time contribution.

If you are interested, please comment here on what type classes or data types you'd like to work on.

[YuvalItzchakov]

@kailuowang I'll start working on Functor :)

[DennisVDB]

I'll be writing them for Semigroup, Group, and Monoid.

[nasadorian]

Kleisli seems pretty barren w.r.t doctests, I can start on that one?

[nasadorian]

@kailuowang So since Kleisli implements quite a few typeclasses, how much doctesting is too much? Should every method be covered? EDIT: I guess you can never have too much test coverage

[kailuowang]

@nasadorian hmm, good question. I think I would focus on methods that are not part of type classes. There a couple of them in KleisliFunctions. Thanks!

[nasadorian]

A little late, but I did not forget! PR is linked... added a handful of doctests and comments to Kleisli! @kailuowang

[hamednourhani]

Hi @kailuowang can i start for Applicatives ?

[vasiliybondarenko]

@kailuowang can I start with OptionT?

[LukaJCB]

@vasiliybondarenko go right ahead!

[hamednourhani]

@kailuowang i checked Applicative. That was done previously. I will work on EitherT.

[hamednourhani]

@kailuowang i will start Validated.

[hamednourhani]

@kailuowang i checked Ior data type. that was interesting and good opportunity to learn. I will start Ior.

[hamednourhani]

@kailuowang i checked the Chain data type as it used widely in cats and i like to add more doctest to it to learn more.

[muskan3006]

I'll pick Show