Add Documentation for Endo
#187
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
foxdonut
suggested changes
Jan 16, 2018
src/Endo/README.md
Outdated
| `Endo` is a `Monoid` that will combine (2) functions that have matching domains | ||
| and codomains (endofunctions) under function composition. Due to the nature | ||
| of `Endo` wrapping a function, the underlying value can either be extracted | ||
| using [`valueOf`](#valueof) like any other `Monoid` or can be executed using |
There was a problem hiding this comment.
can be executed using directly using should be can be executed directly using
src/Endo/README.md
Outdated
| `empty` provides the identity for the `Monoid` in that when the value it | ||
| provides is `concat`ed to any other value, it will return the other value. In | ||
| the case of `Endo` the result of `empty` is the identity function, which echos | ||
| it's input. `empty` is available on both the Constructor and the Instance for |
src/Endo/README.md
Outdated
| Endo a ~> a -> a | ||
| ``` | ||
|
|
||
| `Endo` wraps a function and as such, it's underlying endofunction can be run |
There was a problem hiding this comment.
should be its underlying endofunction
src/Endo/README.md
Outdated
| ``` | ||
|
|
||
| `Endo` wraps a function and as such, it's underlying endofunction can be run | ||
| while inside of an `Endo` by calling `runWith`. Providing a valid value of the |
There was a problem hiding this comment.
there are two spaces between value of the
1 similar comment
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Not just a bike trick anymore
This PR addresses adding the
Endodocumentation from this issue. Once this PR is merged, will do a follow up PR to move this over to the git pages documentation.