Skip to content

Commit

Permalink
address feedback add reviewers as contribs
Browse files Browse the repository at this point in the history
  • Loading branch information
evilsoft committed Jan 15, 2018
1 parent 48c93e9 commit bd03d89
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 14 deletions.
12 changes: 11 additions & 1 deletion .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@
"profile": "https://robertwpearce.com",
"contributions": [
"bug",
"code"
"code",
"review"
]
},
{
Expand All @@ -65,6 +66,15 @@
"contributions": [
"bug"
]
},
{
"login": "foxdonut",
"name": "Fred Daoud",
"avatar_url": "https://avatars3.githubusercontent.com/u/1706600?v=4",
"profile": "http://www.fdaoud.com",
"contributions": [
"review"
]
}
]
}
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,8 +262,8 @@ Thanks goes to these wonderful people ([emoji key][emojis]):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
| [<img src="https://avatars1.githubusercontent.com/u/3665793?v=4" width="100px;"/><br /><sub><b>Ian Hofmann-Hicks</b></sub>](https://github.com/evilsoft)<br />[💻](https://github.com/evilsoft/crocks/commits?author=evilsoft "Code") [📖](https://github.com/evilsoft/crocks/commits?author=evilsoft "Documentation") [📹](#video-evilsoft "Videos") | [<img src="https://avatars0.githubusercontent.com/u/19234385?v=4" width="100px;"/><br /><sub><b>Ryan</b></sub>](https://github.com/rstegg)<br />[💻](https://github.com/evilsoft/crocks/commits?author=rstegg "Code") [🐛](https://github.com/evilsoft/crocks/issues?q=author%3Arstegg "Bug reports") | [<img src="https://avatars0.githubusercontent.com/u/1271181?v=4" width="100px;"/><br /><sub><b>Andrew Van Slaars</b></sub>](http://vanslaars.io)<br />[📖](https://github.com/evilsoft/crocks/commits?author=avanslaars "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/2222191?v=4" width="100px;"/><br /><sub><b>Henrique Limas</b></sub>](https://github.com/HenriqueLimas)<br />[💻](https://github.com/evilsoft/crocks/commits?author=HenriqueLimas "Code") [📖](https://github.com/evilsoft/crocks/commits?author=HenriqueLimas "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/592876?v=4" width="100px;"/><br /><sub><b>Robert Pearce</b></sub>](https://robertwpearce.com)<br />[🐛](https://github.com/evilsoft/crocks/issues?q=author%3Arpearce "Bug reports") [💻](https://github.com/evilsoft/crocks/commits?author=rpearce "Code") | [<img src="https://avatars1.githubusercontent.com/u/888052?v=4" width="100px;"/><br /><sub><b>Scott McCormack</b></sub>](https://github.com/flintinatux)<br />[🐛](https://github.com/evilsoft/crocks/issues?q=author%3Aflintinatux "Bug reports") |
| :---: | :---: | :---: | :---: | :---: | :---: |
| [<img src="https://avatars1.githubusercontent.com/u/3665793?v=4" width="100px;"/><br /><sub><b>Ian Hofmann-Hicks</b></sub>](https://github.com/evilsoft)<br />[💻](https://github.com/evilsoft/crocks/commits?author=evilsoft "Code") [📖](https://github.com/evilsoft/crocks/commits?author=evilsoft "Documentation") [📹](#video-evilsoft "Videos") | [<img src="https://avatars0.githubusercontent.com/u/19234385?v=4" width="100px;"/><br /><sub><b>Ryan</b></sub>](https://github.com/rstegg)<br />[💻](https://github.com/evilsoft/crocks/commits?author=rstegg "Code") [🐛](https://github.com/evilsoft/crocks/issues?q=author%3Arstegg "Bug reports") | [<img src="https://avatars0.githubusercontent.com/u/1271181?v=4" width="100px;"/><br /><sub><b>Andrew Van Slaars</b></sub>](http://vanslaars.io)<br />[📖](https://github.com/evilsoft/crocks/commits?author=avanslaars "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/2222191?v=4" width="100px;"/><br /><sub><b>Henrique Limas</b></sub>](https://github.com/HenriqueLimas)<br />[💻](https://github.com/evilsoft/crocks/commits?author=HenriqueLimas "Code") [📖](https://github.com/evilsoft/crocks/commits?author=HenriqueLimas "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/592876?v=4" width="100px;"/><br /><sub><b>Robert Pearce</b></sub>](https://robertwpearce.com)<br />[🐛](https://github.com/evilsoft/crocks/issues?q=author%3Arpearce "Bug reports") [💻](https://github.com/evilsoft/crocks/commits?author=rpearce "Code") [👀](#review-rpearce "Reviewed Pull Requests") | [<img src="https://avatars1.githubusercontent.com/u/888052?v=4" width="100px;"/><br /><sub><b>Scott McCormack</b></sub>](https://github.com/flintinatux)<br />[🐛](https://github.com/evilsoft/crocks/issues?q=author%3Aflintinatux "Bug reports") | [<img src="https://avatars3.githubusercontent.com/u/1706600?v=4" width="100px;"/><br /><sub><b>Fred Daoud</b></sub>](http://www.fdaoud.com)<br />[👀](#review-foxdonut "Reviewed Pull Requests") |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
<!-- ALL-CONTRIBUTORS-LIST:END -->

### Course/Videos
Expand Down
24 changes: 13 additions & 11 deletions src/Maybe/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
Maybe a = Nothing | Just a
```

Defined as a Sum Type with it's Left side fixed to `()` (`Nothing`), `Maybe` is
Defined as a Sum Type with its left side fixed to `()` (`Nothing`), `Maybe` is
well suited for capturing disjunction when the cause of the "error" case does
not need to be communicated. For example, providing default values on specific
conditions.

A `Maybe` represents disjunction by using (2) constructors, `Nothing` or `Just`.
A `Just` instance represents the truth case while, `Nothing` is considered
A `Just` instance represents the truth case while `Nothing` is considered
false. With the exception of [`coalesce`](#coalesce), all `Maybe` returning
methods on an instance will be applied to a `Just` returning the result. If an
instance is a `Nothing`, then all application is skipped and another `Nothing`
Expand Down Expand Up @@ -126,8 +126,8 @@ Maybe.Just :: a -> Maybe a
```

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.
disjunction or a valid value. `Just` will wrap any given value in
a `Just`, signalling the validity of the wrapped value.

```javascript
const { Just, Nothing } = require('crocks/Maybe')
Expand Down Expand Up @@ -165,10 +165,11 @@ Maybe.of :: a -> Maybe a
```

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
instances. When working specifically with the `Maybe` type, the [`Just`](#just)
constructor should be used. Reach for `of` when working with functions that will
work with ANY `Applicative`/`Monad`.
helper functions that work "generically" with instances of
either `Applicative` or `Monad`. When working specifically with
the `Maybe` type, the [`Just`](#just) constructor should be used. Reach
for `of` when working with functions that will work with
ANY `Applicative`/`Monad`.

```javascript
const Maybe = require('crocks/Maybe')
Expand Down Expand Up @@ -393,10 +394,10 @@ sumList([ 'three', 4, 'five' ])
Maybe a ~> (a -> b) -> Maybe b
```

Used to apply transformations to values in the safely of a `Maybe`, `map` takes
Used to apply transformations to values in the safety of a `Maybe`, `map` takes
a function that it will lift into the context of the `Maybe` and apply to it
the wrapped value. When ran on a `Just` instance, `map` will wrapped value to
the provided function and return the result in a new `Just` instance.
the wrapped value. When ran on a `Just` instance, `map` will apply the wrapped
value to the provided function and return the result in a new `Just` instance.


```javascript
Expand Down Expand Up @@ -566,6 +567,7 @@ Just('hello')
Maybe.of(add)
.ap(Just(29))
.ap(Nothing())
//=> Nothing

fullName({ first: 'Joey', last: 'Fella' })
//=> Just "Joey Fella"
Expand Down

0 comments on commit bd03d89

Please sign in to comment.