Skip to content

Commit

Permalink
move over new monoids and fixup docs for 🌽sistancy
Browse files Browse the repository at this point in the history
  • Loading branch information
Ian Hofmann-Hicks committed Jan 11, 2018
1 parent f877923 commit f9f402d
Show file tree
Hide file tree
Showing 26 changed files with 1,701 additions and 205 deletions.
1,017 changes: 911 additions & 106 deletions docs/package-lock.json

Large diffs are not rendered by default.

3 changes: 1 addition & 2 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"private": true,
"name": "crocks",
"name": "crocks-docs",
"version": "0.0.0",
"scripts": {
"start": "electric run --env dev",
Expand All @@ -13,7 +13,6 @@
"marble": "~3.1.3",
"marble-topbar": "^1.0.0",
"markdown-slug": "^0.1.1",
"markdown-toc": "^1.2.0",
"moment": "^2.19.2"
}
}
10 changes: 10 additions & 0 deletions docs/src/pages/docs/crocks/Arrow.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ arrUpperName
## Constructor Methods

#### id

```haskell
Arrow.id :: () -> Arrow a
```
Expand Down Expand Up @@ -109,6 +110,7 @@ left.runWith(12) //=> '12'


#### type

```haskell
Arrow.type :: () -> String
```
Expand Down Expand Up @@ -143,6 +145,7 @@ isSameType(Arrow(I), Identity) //=> false
## Instance Methods

#### both

```haskell
Pair p => Arrow a b ~> () -> Arrow (p a a) (p b b)
```
Expand Down Expand Up @@ -184,6 +187,7 @@ arrDoubleAndAdd
```

#### compose

```haskell
Arrow a b ~> Arrow b c -> Arrow a c
```
Expand Down Expand Up @@ -232,6 +236,7 @@ arrEvenCount
```

#### contramap

```haskell
Arrow a b ~> (c -> a) -> Arrow c b
```
Expand Down Expand Up @@ -285,6 +290,7 @@ arrAdd10Value
```

#### first

```haskell
Pair p => Arrow a b ~> () -> Arrow (p a c) (p b c)
```
Expand Down Expand Up @@ -324,6 +330,7 @@ flow
```

#### map

```haskell
Arrow a b ~> (b -> c) -> Arrow a c
```
Expand Down Expand Up @@ -365,6 +372,7 @@ arrStringFS
```

#### promap

```haskell
Arrow a b ~> ((c -> a), (b -> d)) -> Arrow c d
```
Expand Down Expand Up @@ -421,6 +429,7 @@ arrTitleObject
```

#### runWith

```haskell
Arrow a b ~> a -> b
```
Expand Down Expand Up @@ -469,6 +478,7 @@ arrAvgList
```

#### second

```haskell
Pair p => Arrow a b ~> () -> Arrow (p c a) (p c b)
```
Expand Down
6 changes: 6 additions & 0 deletions docs/src/pages/docs/crocks/Equiv.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ eq.contramap(length)
## Constructor Methods

#### empty

```haskell
Equiv.empty :: () -> Equiv a a
```
Expand Down Expand Up @@ -101,6 +102,7 @@ empty
```

#### type

```haskell
Equiv.type :: () -> String
```
Expand Down Expand Up @@ -135,6 +137,7 @@ isSameType(Equiv(equals), Endo) //=> false
## Instance Methods

#### concat

```haskell
Equiv a a ~> Equiv a a -> Equiv a a
```
Expand Down Expand Up @@ -200,6 +203,7 @@ run(
```

#### contramap

```haskell
Equiv a a ~> (b -> a) -> Equiv b b
```
Expand Down Expand Up @@ -253,6 +257,7 @@ sameLength
```

#### valueOf

```haskell
Equiv a a ~> () -> a -> a -> Boolean
```
Expand Down Expand Up @@ -312,6 +317,7 @@ test(
```

#### compareWith

```haskell
Equiv a a ~> a -> a -> Boolean
```
Expand Down
6 changes: 6 additions & 0 deletions docs/src/pages/docs/crocks/Pred.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ filter(largeNumber, [ 200, 375, 15 ])
## Constructor Methods

#### empty

```haskell
Pred.empty :: () -> Pred a
```
Expand Down Expand Up @@ -133,6 +134,7 @@ empty
```

#### type

```haskell
Pred.type :: () -> String
```
Expand Down Expand Up @@ -167,6 +169,7 @@ isSameType(Pred(isNil), Maybe) //=> false
## Instance Methods

#### concat

```haskell
Pred a ~> Pred a -> Pred a
```
Expand Down Expand Up @@ -244,6 +247,7 @@ filter(isValid, data)
```

#### contramap

```haskell
Pred a ~> (b -> a) -> Pred b
```
Expand Down Expand Up @@ -301,6 +305,7 @@ validItemLength
```

#### valueOf

```haskell
Pred a ~> () -> a -> Boolean
```
Expand Down Expand Up @@ -357,6 +362,7 @@ fn('') // false
```

#### runWith

```haskell
Pred a ~> a -> Boolean
```
Expand Down
7 changes: 7 additions & 0 deletions docs/src/pages/docs/crocks/Reader.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ flow
## Constructor Methods

#### ask

```haskell
Reader.ask :: () -> Reader e e
Reader.ask :: (e -> b) -> Reader e b
Expand Down Expand Up @@ -99,6 +100,7 @@ ask(add(10))
```

#### of

```haskell
Reader.of :: a -> Reader e a
```
Expand Down Expand Up @@ -136,6 +138,7 @@ Reader.of(57)
```

#### type

```haskell
Reader.type :: () -> String
```
Expand Down Expand Up @@ -170,6 +173,7 @@ isSameType(Reader(I), Identity) //=> false
## Instance Methods

#### map

```haskell
Reader e a ~> (a -> b) -> Reader e b
```
Expand Down Expand Up @@ -218,6 +222,7 @@ Reader.of({ num: 27 })
```

#### ap

```haskell
Reader e (a -> b) ~> Reader e a -> Reader e b
```
Expand Down Expand Up @@ -280,6 +285,7 @@ liftAssign(first, last)
```

#### chain

```haskell
Reader e a ~> (a -> Reader e b) -> Reader e b
```
Expand Down Expand Up @@ -343,6 +349,7 @@ applyTransform(45)
```

#### runWith

```haskell
Reader e a ~> e -> a
```
Expand Down
1 change: 1 addition & 0 deletions docs/src/pages/docs/crocks/ReaderT.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ being wrapped.
## Constructor Methods

#### ask

```haskell
ReaderT.ask :: Monad m => () -> ReaderT e (m e)
ReaderT.ask :: Monad m => (e -> a) -> ReaderT e (m a)
Expand Down
17 changes: 17 additions & 0 deletions docs/src/pages/docs/crocks/State.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ get(toUpper)
## Constructor Methods

#### get

```haskell
State.get :: () -> State s s
State.get :: (s -> a) -> State s a
Expand Down Expand Up @@ -140,6 +141,7 @@ get()
```

#### modify

```haskell
State.modify :: (s -> s) -> State s ()
```
Expand Down Expand Up @@ -182,6 +184,7 @@ addValue(5)
```

#### put

```haskell
State.put :: s -> State s ()
```
Expand Down Expand Up @@ -232,6 +235,7 @@ heckYeah
```

#### of

```haskell
State.of :: a -> State s a
```
Expand Down Expand Up @@ -263,6 +267,7 @@ State.of('hotness')
```

#### type

```haskell
State.type :: () -> String
```
Expand Down Expand Up @@ -297,6 +302,7 @@ isSameType(State.of(false), Reader) //=> false
## Instance Methods

#### map

```haskell
State s a ~> (a -> b) -> State s b
```
Expand Down Expand Up @@ -355,6 +361,7 @@ getNum
```

#### ap

```haskell
State s (a -> b) ~> State s a -> State s b
```
Expand Down Expand Up @@ -423,6 +430,7 @@ applyTax
```

#### chain

```haskell
State s a ~> (a -> State s b) -> State s b
```
Expand Down Expand Up @@ -475,6 +483,7 @@ add(10)
```

#### runWith

```haskell
State s a ~> s -> Pair a s
```
Expand Down Expand Up @@ -511,6 +520,7 @@ update(45)
```

#### evalWith

```haskell
State s a ~> s -> a
```
Expand Down Expand Up @@ -564,6 +574,7 @@ combineNames
```

#### execWith

```haskell
State s a ~> s -> s
```
Expand Down Expand Up @@ -608,6 +619,9 @@ yell
## Pointfree Functions

#### evalWith *(pointfree)*

`crocks/State/evalWith`

```haskell
evalWith :: s -> State s a -> a
```
Expand Down Expand Up @@ -652,6 +666,9 @@ add(1295, 42)
```

#### execWith *(pointfree)*

`crocks/State/execWith`

```haskell
execWith :: s -> State s a -> s
```
Expand Down
1 change: 0 additions & 1 deletion docs/src/pages/docs/crocks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ icon: "code-file"
weight: 2
---

### Crocks
The `crocks` are the heart and soul of this library. This is where you will find
all your favorite ADT's you have grown to love. They include gems such as:
`Maybe`, `Either` and `IO`, to name a few. The are usually just a simple
Expand Down
Loading

0 comments on commit f9f402d

Please sign in to comment.