Merge pull request #38 from hdgarrood/update-boolean-docs

Generalise `and`, `or` documentation

Author: paf31

docs/Data/Foldable.md

@@ -28,15 +28,15 @@ These combinations are documented per function.
 
 ##### Instances
 ``` purescript
-instance foldableArray :: Foldable Array
-instance foldableMaybe :: Foldable Maybe
-instance foldableFirst :: Foldable First
-instance foldableLast :: Foldable Last
-instance foldableAdditive :: Foldable Additive
-instance foldableDual :: Foldable Dual
-instance foldableDisj :: Foldable Disj
-instance foldableConj :: Foldable Conj
-instance foldableMultiplicative :: Foldable Multiplicative
+Foldable Array
+Foldable Maybe
+Foldable First
+Foldable Last
+Foldable Additive
+Foldable Dual
+Foldable Disj
+Foldable Conj
+Foldable Multiplicative
 ```
 
 #### `foldrDefault`
@@ -164,15 +164,19 @@ combining adjacent elements using the specified separator.
 and :: forall a f. (Foldable f, BooleanAlgebra a) => f a -> a
 ```
 
-Test whether all `Boolean` values in a data structure are `true`.
+The conjunction of all the values in a data structure. When specialized
+to `Boolean`, this function will test whether all of the values in a data
+structure are `true`.
 
 #### `or`
 
 ``` purescript
 or :: forall a f. (Foldable f, BooleanAlgebra a) => f a -> a
 ```
 
-Test whether any `Boolean` value in a data structure is `true`.
+The disjunction of all the values in a data structure. When specialized
+to `Boolean`, this function will test whether any of the values in a data
+structure is `true`.
 
 #### `any`
 
@@ -230,4 +234,40 @@ find :: forall a f. (Foldable f) => (a -> Boolean) -> f a -> Maybe a
 
 Try to find an element in a data structure which satisfies a predicate.
 
+#### `maximum`
+
+``` purescript
+maximum :: forall a f. (Ord a, Foldable f) => f a -> Maybe a
+```
+
+Find the largest element of a structure, according to its `Ord` instance.
+
+#### `maximumBy`
+
+``` purescript
+maximumBy :: forall a f. (Foldable f) => (a -> a -> Ordering) -> f a -> Maybe a
+```
+
+Find the largest element of a structure, according to a given comparison
+function. The comparison function should represent a total ordering (see
+the `Ord` type class laws); if it does not, the behaviour is undefined.
+
+#### `minimum`
+
+``` purescript
+minimum :: forall a f. (Ord a, Foldable f) => f a -> Maybe a
+```
+
+Find the smallest element of a structure, according to its `Ord` instance.
+
+#### `minimumBy`
+
+``` purescript
+minimumBy :: forall a f. (Foldable f) => (a -> a -> Ordering) -> f a -> Maybe a
+```
+
+Find the smallest element of a structure, according to a given comparison
+function. The comparison function should represent a total ordering (see
+the `Ord` type class laws); if it does not, the behaviour is undefined.
+
 

docs/Data/Traversable.md

@@ -34,15 +34,15 @@ Default implementations are provided by the following functions:
 
 ##### Instances
 ``` purescript
-instance traversableArray :: Traversable Array
-instance traversableMaybe :: Traversable Maybe
-instance traversableFirst :: Traversable First
-instance traversableLast :: Traversable Last
-instance traversableAdditive :: Traversable Additive
-instance traversableDual :: Traversable Dual
-instance traversableConj :: Traversable Conj
-instance traversableDisj :: Traversable Disj
-instance traversableMultiplicative :: Traversable Multiplicative
+Traversable Array
+Traversable Maybe
+Traversable First
+Traversable Last
+Traversable Additive
+Traversable Dual
+Traversable Conj
+Traversable Disj
+Traversable Multiplicative
 ```
 
 #### `traverseDefault`

src/Data/Foldable.purs

@@ -197,11 +197,15 @@ intercalate sep xs = (foldl go { init: true, acc: mempty } xs).acc
   go { init = true } x = { init: false, acc: x }
   go { acc = acc }   x = { init: false, acc: acc <> sep <> x }
 
--- | Test whether all `Boolean` values in a data structure are `true`.
+-- | The conjunction of all the values in a data structure. When specialized
+-- | to `Boolean`, this function will test whether all of the values in a data
+-- | structure are `true`.
 and :: forall a f. (Foldable f, BooleanAlgebra a) => f a -> a
 and = all id
 
--- | Test whether any `Boolean` value in a data structure is `true`.
+-- | The disjunction of all the values in a data structure. When specialized
+-- | to `Boolean`, this function will test whether any of the values in a data
+-- | structure is `true`.
 or :: forall a f. (Foldable f, BooleanAlgebra a) => f a -> a
 or = any id