Fill out additional docs on things #28
Conversation
src/Data/These.purs
Outdated
| -- | Data type isomorphic to `α ∨ β ∨ (α ∧ β)` or | ||
| -- | `Either a (Either b (Tuple a b))`. | ||
| -- | | ||
| -- | Most type classes instances work on the value of the `b` type. |
There was a problem hiding this comment.
I'm not sure this line is needed, as this is the same Functor behavior that applies to any type with multiple type arguments.
There was a problem hiding this comment.
I think this line should become the new precedent because its helpful for new learners. However, I don't believe strongly in this either. Thoughts?
There was a problem hiding this comment.
I would prefer not to include it -- it's more important that new learners are able to associate this structure with Functor (or Bifunctor). For new learners I would rather have a brief example of using map with a These value in the quick start so they can begin to recognize a very wide-ranging pattern.
There was a problem hiding this comment.
Good point. Fixed
src/Data/These.purs
Outdated
| -- | corresponding default value are wrapped into a `Tuple`. | ||
| -- | Otherwise, the values stored in the `Both` is rewrapped into a `Tuple`. |
There was a problem hiding this comment.
| -- | corresponding default value are wrapped into a `Tuple`. | |
| -- | Otherwise, the values stored in the `Both` is rewrapped into a `Tuple`. | |
| -- | corresponding default value are wrapped into a `Tuple`. Otherwise, the | |
| -- | values stored in the `Both` are re-wrapped into a `Tuple`. |
Minor typo here ("values" -> "are")
Description of the change
Fixes #27
Checklist: