Skip to content

Commit b38b04a

Browse files
committed
Update docs as per @garyb's suggestions
1 parent b771f99 commit b38b04a

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ class (Functor f) <= Alt f where
1111

1212
The `Alt` type class identifies an associative operation on a type.
1313
It is similar to `Semigroup`, except that it applies to types of
14-
kind (* -> *), like Array or List, rather than concrete types like
15-
String or Number.
14+
kind `* -> *`, like `Array` or `List`, rather than concrete types like
15+
`String` or `Number`.
1616

1717
`Alt` instances are required to satisfy the following law:
1818

@@ -317,6 +317,9 @@ class (Alt f) <= Plus f where
317317

318318
The `Plus` type class extends the `Alt` type class with a value that
319319
should be the left and right identity for `(<|>)`.
320+
It is similar to `Monoid`, except that it applies to types of
321+
kind (* -> *), like `Array` or `List`, rather than concrete types like
322+
`String` or `Number`.
320323

321324
`Plus` instances should satisfy the following laws:
322325

src/Control/Alt.purs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ infixl 3 <|>
44

55
-- | The `Alt` type class identifies an associative operation on a type.
66
-- | It is similar to `Semigroup`, except that it applies to types of
7-
-- | kind (* -> *), like Array or List, rather than concrete types like
8-
-- | String or Number.
7+
-- | kind `* -> *`, like `Array` or `List`, rather than concrete types like
8+
-- | `String` or `Number`.
99
-- |
1010
-- | `Alt` instances are required to satisfy the following law:
1111
-- |

src/Control/Plus.purs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ import Control.Alt
44

55
-- | The `Plus` type class extends the `Alt` type class with a value that
66
-- | should be the left and right identity for `(<|>)`.
7+
-- | It is similar to `Monoid`, except that it applies to types of
8+
-- | kind `* -> *`, like `Array` or `List`, rather than concrete types like
9+
-- | `String` or `Number`.
710
-- |
811
-- | `Plus` instances should satisfy the following laws:
912
-- |

0 commit comments

Comments
 (0)