cats icon indicating copy to clipboard operation
cats copied to clipboard

Published 20 hours ago • verified publisher icon typelevel

Documentation megathread

Open LukaJCB opened this issue 7 years ago • 10 comments

I'm trying to compile a thorough collection of everything currently documented and everything we still want to document. I'd also like to talk about a few other things other people brought up. This is sort of meant as a follow up to #1443. Another question that arrises, is if we really need documentation for every single one of these, or if some don't really make sense to have their own page. It might make sense to combine some of these as well (e.g. NonEmpty{List, Vector}).

Type classes:

  • Kernel

    • [x] Eq #1788
    • [ ] PartialOrder
    • [ ] Order
    • [x] Semigroup
    • [x] Monoid
    • [ ] Group
    • [ ] CommutativeSemigroup
    • [ ] Band
    • [ ] CommutativeMonoid
    • [ ] Semilattice
    • [ ] CommutativeGroup
    • [ ] BoundedSemilattice

  • Functor

    • [x] Invariant
    • [x] Contravariant
    • [x] BiFunctor
    • [ ] ProFunctor
    • [ ] Strong

  • Core

    • [x] Functor
    • [x] Apply
    • [x] Applicative
    • [ ] FlatMap
    • [x] Monad
    • [x] Foldable
    • [x] Traverse
    • [x] Reducible #1777
    • [x] NonEmptyTraverse #1787
    • [ ] CoFlatMap
    • [ ] CoMonad
    • [ ] BiMonad
    • [x] BiFoldable
    • [ ] BiTraverse
    • [ ] ApplicativeError
    • [ ] MonadError
    • [ ] CommutativeFlatMap
    • [ ] CommutativeMonad
    • [x] InvariantMonoidal
    • [x] SemigroupK
    • [x] MonoidK
    • [ ] Alternative
    • [x] Show #1789
    • [ ] Inject
    • [ ] InjectK
    • [ ] NotNull
    • [x] Parallel

  • Arrow

    • [x] Arrow #1924
    • [ ] Category
    • [ ] Choice
    • [ ] CommutativeArrow
    • [ ] Compose

Data types

  • [x] Const
  • [x] Kleisli
  • [ ] Cokleisli
  • [x] Id
  • [x] Eval #1816
  • [ ] EitherK
  • [ ] Tuple2K
  • [x] EitherT #1854
  • [x] OptionT
  • [x] State
  • [x] StateT
  • [x] OneAnd
  • [x] NonEmptyList #1971
  • [ ] NonEmptyVector
  • [x] Validated
  • [x] FunctionK
  • [x] Either
  • [x] Ior #1822
  • [ ] WriterT
  • [ ] ReaderWriterStateT
  • [x] Nested

Other:

  1. Laws. Briefly touched on in #510, currently there's no really good place to look for the laws of any given typeclass, I think we should definitely document and emphasize the laws on all the type classes.
  2. Type class instances. Suggested in #1287, it would be really nice if we had some way to see all the defined instances for every type class we include in cats.

If I missed anything just tell me and I'll try to edit :)

LukaJCB avatar Aug 08 '17 17:08 LukaJCB

Working on docs for Arrow in the Scala world spree.

zliu41 avatar Sep 20 '17 13:09 zliu41

Having worked with docs for #1678 (PR #1903), I'll take NonEmptyList docs :)

AlejandroME avatar Sep 25 '17 11:09 AlejandroME

I'll start on the Alternative docs, unless someone else beats me to it.

stephen-lazaro avatar Dec 15 '17 21:12 stephen-lazaro

I would like to do Order, unless you think PartialOrder should come first :)

kubukoz avatar May 26 '18 14:05 kubukoz

I'll pick up Profunctor and Strong next unless someone beats me to it.

stephen-lazaro avatar Oct 20 '18 20:10 stephen-lazaro

I take WriterT as requested here #625 as well :wink:

https://github.com/typelevel/cats/pull/3618 Here the PR. Go There and tell me how terrible it is (a lot)

benkio avatar Sep 17 '20 15:09 benkio

I've checked the current mdoc. I would like to cover in the following week:

  • BiMonad
  • BiFoldable
  • BiTraverse

Later edit:

  • #4076
  • #4109

gatear avatar Dec 02 '21 21:12 gatear

Seems that Alternative is already covered here, isn't it? But there's a new typeclass NonEmptyAlternative already, which apparently is not.

satorg avatar Dec 02 '21 22:12 satorg

Documentation for CoMonad and CoFlatMap already exists via #2888

gatear avatar Dec 08 '21 15:12 gatear

I will start working on StateT 😉

EDIT: Just opened the PR #4126

benkio avatar Feb 02 '22 21:02 benkio