Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up heading on existing READMEs #186

Merged
merged 1 commit into from
Jan 16, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/src/pages/docs/monoids/All.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ weight: 10
All Boolean
```

`All` is a `Monoid` that will combine two values of any type using logical
`All` is a `Monoid` that will combine (2) values of any type using logical
conjunction (AND) on their coerced `Boolean` values, mapping truth-y values to
`true` and false-y values to `false`.

Expand Down Expand Up @@ -109,7 +109,7 @@ All ~> All -> All
```

`concat` is used to combine (2) `Semigroup`s of the same type under an operation
specified by the `Semigroup`. In the case of `All`, it will combine the two
specified by the `Semigroup`. In the case of `All`, it will combine the (2)
using logical AND (conjunction).

```javascript
Expand All @@ -136,7 +136,7 @@ will result in the underlying `Boolean` value.
```javascript
const All = require('crocks/All')

All(0).value() //=> false
All(0).valueOf() //=> false
All('string').valueOf() //=> true

//=> false
Expand Down
6 changes: 3 additions & 3 deletions docs/src/pages/docs/monoids/Any.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ weight: 20
Any Boolean
```

`Any` is a `Monoid` that will combine two values of any type using logical
`Any` is a `Monoid` that will combine (2) values of any type using logical
disjunction (OR) on their coerced `Boolean` values, mapping truth-y values to
`true` and false-y values to `false`.

Expand Down Expand Up @@ -114,7 +114,7 @@ Any ~> Any -> Any
```

`concat` is used to combine (2) `Semigroup`s of the same type under an operation
specified by the `Semigroup`. In the case of `Any`, it will combine the two
specified by the `Semigroup`. In the case of `Any`, it will combine the (2)
using logical OR (disjunction).

```javascript
Expand All @@ -135,7 +135,7 @@ Any ~> () -> Boolean
`valueOf` is used on all `crocks` `Monoid`s as a means of extraction. While the
extraction is available, types that implement `valueOf` are not necessarily a
`Comonad`. This function is used primarily for convenience for some of the
helper functions that ship with `crocks`. Calling `value` on an `Any` instance
helper functions that ship with `crocks`. Calling `valueOf` on an `Any` instance
will result in the underlying `Boolean` value.

```javascript
Expand Down
15 changes: 7 additions & 8 deletions src/All/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
All Boolean
```

`All` is a `Monoid` that will combine two values of any type using logical
`All` is a `Monoid` that will combine (2) values of any type using logical
conjunction (AND) on their coerced `Boolean` values, mapping truth-y values to
`true` and false-y values to `false`.

Expand Down Expand Up @@ -39,7 +39,7 @@ allGood([ 'nice', '00', null ])

## Constructor Methods

### empty
#### empty

```haskell
All.empty :: () -> All
Expand All @@ -59,8 +59,7 @@ All(true).concat(All.empty()) //=> All true
All(false).concat(All.empty()) //=> All false
```


### type
#### type

```haskell
All.type :: () -> String
Expand Down Expand Up @@ -90,14 +89,14 @@ isSameType(All(false), Maybe) //=> false

## Instance Methods

### concat
#### concat

```haskell
All ~> All -> All
```

`concat` is used to combine (2) `Semigroup`s of the same type under an operation
specified by the `Semigroup`. In the case of `All`, it will combine the two
specified by the `Semigroup`. In the case of `All`, it will combine the (2)
using logical AND (conjunction).

```javascript
Expand All @@ -109,7 +108,7 @@ All(false).concat(All(true)) //=> All false
All(false).concat(All(false)) //=> All false
```

### valueOf
#### valueOf

```haskell
All ~> () -> Boolean
Expand All @@ -124,7 +123,7 @@ will result in the underlying `Boolean` value.
```javascript
const All = require('crocks/All')

All(0).value() //=> false
All(0).valueOf() //=> false
All('string').valueOf() //=> true

//=> false
Expand Down
14 changes: 7 additions & 7 deletions src/Any/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Any Boolean
```

`Any` is a `Monoid` that will combine two values of any type using logical
`Any` is a `Monoid` that will combine (2) values of any type using logical
disjunction (OR) on their coerced `Boolean` values, mapping truth-y values to
`true` and false-y values to `false`.

Expand Down Expand Up @@ -40,7 +40,7 @@ anyNumber([ true, 'string' ])

## Constructor Methods

### empty
#### empty

```haskell
Any.empty :: () -> Any
Expand All @@ -61,7 +61,7 @@ Any(false).concat(Any.empty()) //=> Any false
```


### type
#### type

```haskell
Any.type :: () -> String
Expand Down Expand Up @@ -93,14 +93,14 @@ isSameType(Any, Assign({ food: 'always' }))

## Instance Methods

### concat
#### concat

```haskell
Any ~> Any -> Any
```

`concat` is used to combine (2) `Semigroup`s of the same type under an operation
specified by the `Semigroup`. In the case of `Any`, it will combine the two
specified by the `Semigroup`. In the case of `Any`, it will combine the (2)
using logical OR (disjunction).

```javascript
Expand All @@ -112,7 +112,7 @@ Any(false).concat(Any(true)) //=> Any true
Any(false).concat(Any(false)) //=> Any false
```

### valueOf
#### valueOf

```haskell
Any ~> () -> Boolean
Expand All @@ -121,7 +121,7 @@ Any ~> () -> Boolean
`valueOf` is used on all `crocks` `Monoid`s as a means of extraction. While the
extraction is available, types that implement `valueOf` are not necessarily a
`Comonad`. This function is used primarily for convenience for some of the
helper functions that ship with `crocks`. Calling `value` on an `Any` instance
helper functions that ship with `crocks`. Calling `valueOf` on an `Any` instance
will result in the underlying `Boolean` value.

```javascript
Expand Down
20 changes: 10 additions & 10 deletions src/Arrow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ arrUpperName

## Constructor Methods

### id
#### id

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

### type
#### type

```haskell
Arrow.type :: () -> String
Expand Down Expand Up @@ -127,7 +127,7 @@ isSameType(Arrow(I), Identity) //=> false

## Instance Methods

### both
#### both

```haskell
Pair p => Arrow a b ~> () -> Arrow (p a a) (p b b)
Expand Down Expand Up @@ -169,7 +169,7 @@ arrDoubleAndAdd
.runWith(Pair(200, 10)) //=> 420
```

### compose
#### compose

```haskell
Arrow a b ~> Arrow b c -> Arrow a c
Expand Down Expand Up @@ -219,7 +219,7 @@ arrEvenCount
//=> 3
```

### contramap
#### contramap

```haskell
Arrow a b ~> (c -> a) -> Arrow c b
Expand Down Expand Up @@ -273,7 +273,7 @@ arrAdd10Value
//=> 10
```

### first
#### first

```haskell
Pair p => Arrow a b ~> () -> Arrow (p a c) (p b c)
Expand Down Expand Up @@ -313,7 +313,7 @@ flow
//=> { original: 'taco time', result: 'TACO TIME' }
```

### map
#### map

```haskell
Arrow a b ~> (b -> c) -> Arrow a c
Expand Down Expand Up @@ -355,7 +355,7 @@ arrStringFS
//=> '-9.12 dbFS'
```

### promap
#### promap

```haskell
Arrow a b ~> ((c -> a), (b -> d)) -> Arrow c d
Expand Down Expand Up @@ -412,7 +412,7 @@ arrTitleObject
// { title: '' }
```

### runWith
#### runWith

```haskell
Arrow a b ~> a -> b
Expand Down Expand Up @@ -461,7 +461,7 @@ arrAvgList
//=> 54.25
```

### second
#### second

```haskell
Pair p => Arrow a b ~> () -> Arrow (p c a) (p c b)
Expand Down
8 changes: 4 additions & 4 deletions src/Assign/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Assign(first)

## Constructor Methods

### empty
#### empty

```haskell
Assign.empty :: () -> Assign
Expand All @@ -50,7 +50,7 @@ Assign({ a: 1 })
//=> Assign { a: 1 }
```

### type
#### type

```haskell
Assign.type :: () -> String
Expand Down Expand Up @@ -88,7 +88,7 @@ isSameType(Assign, myData)

## Instance Methods

### concat
#### concat

```haskell
Assign ~> Assign -> Assign
Expand Down Expand Up @@ -119,7 +119,7 @@ Assign({ b: 4 })
//=> Assign { b: 4, a: 1 }
```

### valueOf
#### valueOf

```haskell
Assign ~> () -> Object
Expand Down
12 changes: 6 additions & 6 deletions src/Equiv/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ eq.contramap(length)

## Constructor Methods

### empty
#### empty

```haskell
Equiv.empty :: () -> Equiv a a
Expand Down Expand Up @@ -91,7 +91,7 @@ empty
//=> false
```

### type
#### type

```haskell
Equiv.type :: () -> String
Expand Down Expand Up @@ -122,7 +122,7 @@ isSameType(Equiv(equals), Endo) //=> false

## Instance Methods

### concat
#### concat

```haskell
Equiv a a ~> Equiv a a -> Equiv a a
Expand Down Expand Up @@ -188,7 +188,7 @@ run(
// false
```

### contramap
#### contramap

```haskell
Equiv a a ~> (b -> a) -> Equiv b b
Expand Down Expand Up @@ -242,7 +242,7 @@ sameLength
//=> false
```

### valueOf
#### valueOf

```haskell
Equiv a a ~> () -> a -> a -> Boolean
Expand Down Expand Up @@ -302,7 +302,7 @@ test(
//=> true
```

### compareWith
#### compareWith

```haskell
Equiv a a ~> a -> a -> Boolean
Expand Down
Loading