Document classes and methods

[truizlop]

If you are documenting one of these classes, create a separate issue and assign it to yourself so that everyone knows what is being done.

We will keep track of what is documented here. For now, I will list all current classes in the library. We should also generate the HTML documents based on this (perhaps using Jazzy or similar). Sorted by priority and with an indicator of difficulty (📗 easy, 📒 medium, 📕 hard to document):

Data

• Action 📕
• ArrayK 📗
• CoT 📕
• Const 📗
• Coproduct 📒
• Coreader 📒
• CoSum 📕
• Day 📕
• DictionaryK 📗
• Either 📗
• Endo 📒
• Eval 📗
• Id 📗
• Ior 📗
• Moore 📕
• NonEmptyArray 📗
• Option 📗
• Pairing 📕
• Puller 📕
• Reader 📗
• SetK 📗
• State 📗
• Sum 📕
• Trampoline 📒
• Try 📗
• Validated 📗
• Zipper 📕

Instances

• BoolInstances 📗
• OptionInstances 📗
• NumberInstances 📗
• StringInstances 📗

Syntax

• HigherKinds 📒
• BooleanFunctions 📗
• Curry 📗
• Memoization 📗
• PartialApplication 📗
• Predef 📗
• Reverse 📗

Typeclasses

• Alternative 📒
• Applicative 📗
• ApplicativeError 📗
• Bimonad 📒
• Comonad 📒
• ComonadEnv 📒
• ComonadStore 📒
• ComonadTraced 📒
• ComonadTrans 📒
• Contravariant 📗
• Decidable 📗
• Divide 📗
• Divisible 📗
• EquatableK 📗
• Foldable 📒
• Functor 📗
• FunctorFilter 📗
• Invariant 📗
• Monad 📗
• MonadCombine 📗
• MonadError 📗
• MonadFilter 📗
• MonadReader 📒
• MonadState 📒
• MonadWriter 📒
• Monoid 📗
• Monoidal 📗
• MonoidK 📗
• NonEmptyReducible 📗
• Reducible 📗
• Selective 📒
• Semigroup 📗
• SemigroupK 📗
• Semiring 📗
• Traverse 📒
• TraverseFilter 📒

Transformers

• EitherT 📒
• OptionT 📒
• StateT 📒
• WriterT 📒
• StoreT 📕
• TracedT 📕
• EnvT 📕

Effects

• Atomic 📒
• IO 📒
• Ref 📒
• Resource 📒

Effects/Foundation

• ConsoleIO 📗
• FileManager
• URLSession 📗

Effects/Rx

• MaybeK 📒
• ObservableK 📒
• SingleK 📒

Effects/Typeclasses

• Async 📒
• Bracket 📒
• Concurrent 📒
• ConcurrentEffect 📒
• Effect 📒
• MonadDefer 📒
• UnsafeRun 📒
• EffectComprehensions 📒

Arrow

• Cokleisli 📒
• Function0 📗
• Function1 📗
• FunctionK 📒
• Kleisli 📒

Optics/Typeclasses

• At 📒
• Cons 📒
• Each 📒
• FilterIndex 📒
• Index 📒
• Snoc 📒

Optics

• BoundSetter 📒
• Fold 📒
• Getter 📒
• Iso 📒
• Lens 📒
• Optional 📒
• Prism 📒
• Setter 📒
• Traversal 📒

Optics/DSL

• At+Optics 📒
• Each+Optics 📒
• Index+Optics 📒
• Kind+Optics 📒

Optics/Instances

• ArrayKOpticsInstances 📒
• ArrayOpticsInstances 📒
• ConstOpticsInstances 📒
• EitherKOpticsInstances 📒
• EitherOpticsInstances 📒
• IdOpticsInstances 📒
• IorOpticsInstances 📒
• OptionOpticsInstances 📒
• NonEmptyArrayOpticsInstances 📒
• StringOpticsInstances 📒
• TryOpticsInstances 📒
• ValidatedOpticsInstances 📒

Optics/STD

• Either+Optics 📗
• Id+Optics 📗
• Ior+Optics 📗
• ArrayK+Optics 📗
• Option+Optics 📗
• NonEmptyArray+Optics 📗
• Result+Optics 📗
• String+Optics 📗
• Try+Optics 📗
• Validated+Optics 📗

Optics/Tuple

• Tuple2 📗
• Tuple3 📗
• Tuple4 📗
• Tuple5 📗
• Tuple6 📗
• Tuple7 📗
• Tuple8 📗
• Tuple9 📗
• Tuple10 📗

Optics/Auto

• AutoFold 📗
• AutoGetter 📗
• AutoLens 📗
• AutoOptics 📗
• AutoOptional 📗
• AutoPrism 📗
• AutoSetter 📗
• AutoTraversal 📗

Free

• Cofree 📕
• Coyoneda 📕
• Free 📕
• Yoneda 📕

RecursionSchemes

• Recursion 📕

RecursionSchemes/Data

• Fix 📕
• Mu 📕
• Nu 📕

RecursionSchemes/Typeclasses

• Birecursive 📕
• Corecursive 📕
• Recursive 📕

Generic

• Generic 📕
• HList 📕
• Product 📕
• Coproduct2 📕
• Coproduct3 📕
• Coproduct4 📕
• Coproduct5 📕
• Coproduct6 📕
• Coproduct7 📕
• Coproduct8 📕
• Coproduct9 📕
• Coproduct10 📕

[lareenmelo]

Hi! I will work on this Issue for Hacktoberfest!

[truizlop]

@lareenmelo nice! Please, create individual issues for the items that you are working on so that everyone else knows and we do not duplicate work.