Add Maybe Documentation
#185
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
reviewed
Jan 15, 2018
|
|
||
| Maybe.of(add) | ||
| .ap(Just(29)) | ||
| .ap(Nothing()) |
rpearce
reviewed
Jan 15, 2018
src/Maybe/README.md
Outdated
| conditions. | ||
|
|
||
| A `Maybe` represents disjunction by using (2) constructors, `Nothing` or `Just`. | ||
| A `Just` instance represents the truth case while, `Nothing` is considered |
There was a problem hiding this comment.
methinks you don't need a comma here
src/Maybe/README.md
Outdated
|
|
||
| Used to construct a `Just` instance that represents the "true" portion of a | ||
| disjunction or a valid value. `Just` will wrap any given value in a `Just`, | ||
| which signals the validity of the wrapped value. |
There was a problem hiding this comment.
Another comma thing... how do either of these work for ya:
`Just` will wrap any given value in a `Just`, and this signals the validity of the wrapped value.
or
`Just` will wrap any given value in a `Just`, signalling the validity of the wrapped value.
src/Maybe/README.md
Outdated
| ``` | ||
|
|
||
| Used to wrap any value into a `Maybe` as a `Just`, `of` is used mostly by | ||
| helper functions that work "generically" with `Applicative` or `Monad` types |
There was a problem hiding this comment.
"types" should probs be "type" as "instances" covers the plurality?
There was a problem hiding this comment.
Actually think we can 🔪 the word type altogether.
|
|
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.
This is good...Maybe?
This PR adds the README documentation for the
Maybetype and all of it's support functions. Also updated some issues with some of the siggys.Once this is merged, there will follow another PR to move this into the documents.
This goes against this issue