Documentation for Identity #330

dalefrancis88 · 2018-10-22T05:59:26Z

This is the initial commit for the Identity documentation for #42

This is the initial commit for the `Identity` documentation for #42

coveralls · 2018-10-23T07:28:44Z

Coverage remained the same at 100.0% when pulling ac78f8f on docs/Identity into 4ab96f5 on master.

evilsoft

Some initial feedback

evilsoft · 2018-10-23T17:26:23Z

docs/src/pages/docs/crocks/Identity.md

+<article id="topic-implements">
+
+## Implements
+`Setoid`, `Semigroup`, `Functor`, `Chain`, `Traversable`, `Apply`, `Applicative`, `Monad`


This list need to be in order of constraints imposed, so:

Setoid, Semigroup, Functor, Apply, Traversable, Chain, Applicative, Monad

evilsoft · 2018-10-23T17:52:14Z

docs/src/pages/docs/crocks/Identity.md

+Identity a
+```
+
+`Identity` is one of the most versatile `monads`. Although it does not have any 


Worried that this may be to much and going a little to deep on the Category Theory for the average learner.
Could the description be something like:

Identity is a crock that can be used to wrap a common interface around existing Javascript types and functions. It maintains integrity by lifting and applying functions and types as is, without adding any additional structure or effects. By not applying and additional structure to existing functions, Identity can be swapped in and out for other Functors that do apply their own structure and effects.

Or something along those lines. Talk more about usage, then theory. Still give a little theory to put it in context with the other types, but focus more on its usage in the grand scheme of things. Without giving away too much.

(boy that is a wishy-washy suggestion)

Haha all good. Never thought the roles would be reversed and you'd tell me i was being too theoretical :)

evilsoft · 2018-10-23T17:55:19Z

docs/src/pages/docs/crocks/index.md

@@ -22,7 +22,7 @@ names, but what they do from type to type may vary.
 | [`Const`][const] | -- | [`ap`][const-ap], [`chain`][const-chain], [`concat`][const-concat], [`equals`][const-equals], [`map`][const-map], [`valueOf`][const-valueof] |
 | [`Either`][either] | [`Left`][either-left], [`Right`][either-right], [`of`][either-of]| [`alt`][either-alt], [`ap`][either-ap], [`bimap`][either-bimap], [`chain`][either-chain], [`coalesce`][either-coalesce], [`concat`][either-concat], [`either`][either-either], [`equals`][either-equals], [`map`][either-map], [`of`][either-of], [`sequence`][either-sequence], [`swap`][either-swap], [`traverse`][either-traverse] |
 | [`Equiv`][equiv] | [`empty`][equiv-empty] | [`concat`][equiv-concat], [`contramap`][equiv-contra], [`compareWith`][equiv-compare], [`valueOf`][equiv-value] |
-| `Identity` | `of` | `ap`, `chain`, `concat`, `equals`, `map`, `of`, `sequence`, `traverse`, `valueOf` |
+| [`Identity`][identity] | [`of`][identity-of] | [`ap`][identity-ap], [`chain`][identity-chain], [`concat`][identity-concat], [`equals`][identity-equals], [`map`][identity-map], [`of`][identity-of], [`sequence`][identity-sequence], [`traverse`][identity-traverse], [`valueOf`][identity-valueOf] |


link refs should be all lowercase:

identity-valueOf -> identity-valueof

also missing the identity-valueof ref below.

evilsoft · 2018-10-23T17:56:34Z

docs/src/pages/docs/crocks/Identity.md

+
+of(true)
+//=> Identity true
+


extra newline here, fences should hug the code tightly.

evilsoft · 2018-10-23T17:57:27Z

docs/src/pages/docs/crocks/Identity.md

+
+Used to compare the underlying values of two `Identity` instances for equality by
+value, `equals` takes any given argument and returns `true` if the passed
+arguments is a `Identity` with an underlying value equal to the underlying value


a Identity -> an Identity

evilsoft · 2018-10-23T17:59:35Z

docs/src/pages/docs/crocks/Identity.md

+Identity (a -> b) ~> Identity a -> Identity b
+```
+
+`ap` allows for values wrapped in a `Identity` to be applied to functions also


a Identity -> an Identity

evilsoft · 2018-10-23T17:59:41Z

docs/src/pages/docs/crocks/Identity.md

+```
+
+`ap` allows for values wrapped in a `Identity` to be applied to functions also
+wrapped in a `Identity`. In order to use `ap`, the `Identity` must contain a


a Identity -> an Identity

evilsoft · 2018-10-23T18:00:01Z

docs/src/pages/docs/crocks/Identity.md

+wrapped in a `Identity`. In order to use `ap`, the `Identity` must contain a
+function as its value. Under the hood, `ap` unwraps both the function
+and the value to be applied and applies the value to the function. Finally it
+will wrap the result of that application back into a `Identity`. It is required


a Identity -> an Identity

evilsoft · 2018-10-23T18:01:21Z

docs/src/pages/docs/crocks/Identity.md

+
+When an instance of `Identity` wraps an `Apply` instance, `sequence` can be used to
+swap the type sequence. `sequence` requires either an `Applicative TypeRep` or
+an `Apply` returning function is provided for its argument.


is provided -> to be provided
(may need to fix this in a couple places if this was copied)

This came from Maybe. After this commit i'll make that channge

evilsoft · 2018-10-23T18:03:16Z

docs/src/pages/docs/crocks/Identity.md

+
+Normally one of the ways `Monad`s like `Identity` are able to be combined and 
+have their effects applied is through `chain`. However `Identity` is different
+because there are no effects to apply. `chain` will simply take a func that 


func -> function

HenriqueLimas · 2018-10-28T12:54:25Z

docs/src/pages/docs/crocks/Identity.md

+```
+
+`of` is used to construct an `Identity` with any given value. It is there to
+allow `Identity` to function as a pointed functor. 


to function -> to work

HenriqueLimas · 2018-10-28T12:57:03Z

docs/src/pages/docs/crocks/Identity.md

+
+const { of } = Identity
+
+of(42)


Can we use Identity.of instead, just for consistency since we use in that way in other docs.

HenriqueLimas · 2018-10-28T13:13:51Z

docs/src/pages/docs/crocks/Identity.md

+
+`traverse` requires either an `Applicative TypeRep` or an `Apply` returning
+function as its first argument and a function that is used to apply the "effect"
+of the target  `Apply` to the value inside of the `Identity`. Both arguments must provide


Extra space after target

damn man, nice 👀!

HenriqueLimas

LGTM, nice one 🎉 👍

dalefrancis88 added 2 commits October 21, 2018 22:58

Initial scaffolding for Identity

566c922

This is the initial commit for the `Identity` documentation for #42

Added Chain updated map and constructor docs

597e3b8

Adding to index, updated sequence

588ce68

evilsoft reviewed Oct 23, 2018

View reviewed changes

dalefrancis88 changed the title ~~Initial scaffolding for Identity~~ Documentation for Identity Oct 23, 2018

dalefrancis88 added 2 commits October 23, 2018 13:49

Changes per review plus added sequence docs

c19b3c0

Missed an extra line

246c005

dalefrancis88 requested review from evilsoft and HenriqueLimas October 23, 2018 20:52

bahaviour -> behavior

d705062

dalefrancis88 requested a review from karthikiyengar October 26, 2018 17:30

HenriqueLimas reviewed Oct 28, 2018

View reviewed changes

dalefrancis88 added 2 commits October 28, 2018 22:43

Merge branch 'master' into docs/Identity

7580bc6

Updates per review

ac78f8f

dalefrancis88 requested a review from HenriqueLimas October 29, 2018 22:03

HenriqueLimas approved these changes Oct 29, 2018

View reviewed changes

dalefrancis88 merged commit 6f16346 into master Oct 29, 2018

dalefrancis88 deleted the docs/Identity branch October 29, 2018 23:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation for Identity #330

Documentation for Identity #330

dalefrancis88 commented Oct 22, 2018 •

edited

Loading

coveralls commented Oct 23, 2018 •

edited

Loading

evilsoft left a comment

evilsoft Oct 23, 2018

evilsoft Oct 23, 2018

dalefrancis88 Oct 23, 2018

evilsoft Oct 23, 2018

evilsoft Oct 23, 2018

evilsoft Oct 23, 2018

evilsoft Oct 23, 2018

evilsoft Oct 23, 2018

evilsoft Oct 23, 2018

evilsoft Oct 23, 2018

dalefrancis88 Oct 23, 2018

evilsoft Oct 23, 2018

HenriqueLimas Oct 28, 2018

HenriqueLimas Oct 28, 2018

HenriqueLimas Oct 28, 2018

dalefrancis88 Oct 29, 2018

HenriqueLimas left a comment


		of(true)
		//=> Identity true


		const { of } = Identity

		of(42)

Documentation for Identity #330

Documentation for Identity #330

Conversation

dalefrancis88 commented Oct 22, 2018 • edited Loading

coveralls commented Oct 23, 2018 • edited Loading

evilsoft left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HenriqueLimas left a comment

Choose a reason for hiding this comment

dalefrancis88 commented Oct 22, 2018 •

edited

Loading

coveralls commented Oct 23, 2018 •

edited

Loading