bow icon indicating copy to clipboard operation
bow copied to clipboard

Published 20 hours ago • verified publisher icon bow-swift

Document classes and methods

Open truizlop opened this issue 6 years ago • 2 comments

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

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

Instances

  • [x] BoolInstances 📗
  • [x] OptionInstances 📗
  • [x] NumberInstances 📗
  • [x] StringInstances 📗

Syntax

  • [x] HigherKinds 📒
  • [x] BooleanFunctions 📗
  • [x] Curry 📗
  • [x] Memoization 📗
  • [x] PartialApplication 📗
  • [x] Predef 📗
  • [x] Reverse 📗

Typeclasses

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

Transformers

  • [x] EitherT 📒
  • [x] OptionT 📒
  • [x] StateT 📒
  • [x] WriterT 📒
  • [x] StoreT 📕
  • [x] TracedT 📕
  • [x] EnvT 📕

Effects

  • [x] Atomic 📒
  • [x] IO 📒
  • [x] Ref 📒
  • [x] Resource 📒

Effects/Foundation

  • [x] ConsoleIO 📗
  • [x] FileManager
  • [x] URLSession 📗

Effects/Rx

  • [x] MaybeK 📒
  • [x] ObservableK 📒
  • [x] SingleK 📒

Effects/Typeclasses

  • [x] Async 📒
  • [x] Bracket 📒
  • [x] Concurrent 📒
  • [x] ConcurrentEffect 📒
  • [x] Effect 📒
  • [x] MonadDefer 📒
  • [x] UnsafeRun 📒
  • [x] EffectComprehensions 📒

Arrow

  • [x] Cokleisli 📒
  • [x] Function0 📗
  • [x] Function1 📗
  • [x] FunctionK 📒
  • [x] Kleisli 📒

Optics/Typeclasses

  • [x] At 📒
  • [x] Cons 📒
  • [x] Each 📒
  • [x] FilterIndex 📒
  • [x] Index 📒
  • [x] Snoc 📒

Optics

  • [x] BoundSetter 📒
  • [x] Fold 📒
  • [x] Getter 📒
  • [x] Iso 📒
  • [x] Lens 📒
  • [x] Optional 📒
  • [x] Prism 📒
  • [x] Setter 📒
  • [x] Traversal 📒

Optics/DSL

  • [x] At+Optics 📒
  • [x] Each+Optics 📒
  • [x] Index+Optics 📒
  • [x] Kind+Optics 📒

Optics/Instances

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

Optics/STD

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

Optics/Tuple

  • [x] Tuple2 📗
  • [x] Tuple3 📗
  • [x] Tuple4 📗
  • [x] Tuple5 📗
  • [x] Tuple6 📗
  • [x] Tuple7 📗
  • [x] Tuple8 📗
  • [x] Tuple9 📗
  • [x] Tuple10 📗

Optics/Auto

  • [x] AutoFold 📗
  • [x] AutoGetter 📗
  • [x] AutoLens 📗
  • [x] AutoOptics 📗
  • [x] AutoOptional 📗
  • [x] AutoPrism 📗
  • [x] AutoSetter 📗
  • [x] AutoTraversal 📗

Free

  • [x] Cofree 📕
  • [x] Coyoneda 📕
  • [x] Free 📕
  • [x] Yoneda 📕

RecursionSchemes

  • [ ] Recursion 📕

RecursionSchemes/Data

  • [ ] Fix 📕
  • [ ] Mu 📕
  • [ ] Nu 📕

RecursionSchemes/Typeclasses

  • [ ] Birecursive 📕
  • [ ] Corecursive 📕
  • [ ] Recursive 📕

Generic

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

truizlop avatar Nov 08 '18 17:11 truizlop

Hi! I will work on this Issue for Hacktoberfest!

lareenmelo avatar Oct 02 '19 00:10 lareenmelo

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

truizlop avatar Oct 02 '19 07:10 truizlop