Skip to content

Commit fdde8bf

Browse files
committed
Regen docs
1 parent ff9d82b commit fdde8bf

File tree

2 files changed

+60
-20
lines changed

2 files changed

+60
-20
lines changed

docs/Data/Foldable.md

Lines changed: 51 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ These combinations are documented per function.
2828

2929
##### Instances
3030
``` purescript
31-
instance foldableArray :: Foldable Array
32-
instance foldableMaybe :: Foldable Maybe
33-
instance foldableFirst :: Foldable First
34-
instance foldableLast :: Foldable Last
35-
instance foldableAdditive :: Foldable Additive
36-
instance foldableDual :: Foldable Dual
37-
instance foldableDisj :: Foldable Disj
38-
instance foldableConj :: Foldable Conj
39-
instance foldableMultiplicative :: Foldable Multiplicative
31+
Foldable Array
32+
Foldable Maybe
33+
Foldable First
34+
Foldable Last
35+
Foldable Additive
36+
Foldable Dual
37+
Foldable Disj
38+
Foldable Conj
39+
Foldable Multiplicative
4040
```
4141

4242
#### `foldrDefault`
@@ -164,15 +164,19 @@ combining adjacent elements using the specified separator.
164164
and :: forall a f. (Foldable f, BooleanAlgebra a) => f a -> a
165165
```
166166

167-
Test whether all `Boolean` values in a data structure are `true`.
167+
The conjunction of all the values in a data structure. When specialized
168+
to `Boolean`, this function will test whether all of the values in a data
169+
structure are `true`.
168170

169171
#### `or`
170172

171173
``` purescript
172174
or :: forall a f. (Foldable f, BooleanAlgebra a) => f a -> a
173175
```
174176

175-
Test whether any `Boolean` value in a data structure is `true`.
177+
The disjunction of all the values in a data structure. When specialized
178+
to `Boolean`, this function will test whether any of the values in a data
179+
structure is `true`.
176180

177181
#### `any`
178182

@@ -230,4 +234,40 @@ find :: forall a f. (Foldable f) => (a -> Boolean) -> f a -> Maybe a
230234

231235
Try to find an element in a data structure which satisfies a predicate.
232236

237+
#### `maximum`
238+
239+
``` purescript
240+
maximum :: forall a f. (Ord a, Foldable f) => f a -> Maybe a
241+
```
242+
243+
Find the largest element of a structure, according to its `Ord` instance.
244+
245+
#### `maximumBy`
246+
247+
``` purescript
248+
maximumBy :: forall a f. (Foldable f) => (a -> a -> Ordering) -> f a -> Maybe a
249+
```
250+
251+
Find the largest element of a structure, according to a given comparison
252+
function. The comparison function should represent a total ordering (see
253+
the `Ord` type class laws); if it does not, the behaviour is undefined.
254+
255+
#### `minimum`
256+
257+
``` purescript
258+
minimum :: forall a f. (Ord a, Foldable f) => f a -> Maybe a
259+
```
260+
261+
Find the smallest element of a structure, according to its `Ord` instance.
262+
263+
#### `minimumBy`
264+
265+
``` purescript
266+
minimumBy :: forall a f. (Foldable f) => (a -> a -> Ordering) -> f a -> Maybe a
267+
```
268+
269+
Find the smallest element of a structure, according to a given comparison
270+
function. The comparison function should represent a total ordering (see
271+
the `Ord` type class laws); if it does not, the behaviour is undefined.
272+
233273

docs/Data/Traversable.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ Default implementations are provided by the following functions:
3434

3535
##### Instances
3636
``` purescript
37-
instance traversableArray :: Traversable Array
38-
instance traversableMaybe :: Traversable Maybe
39-
instance traversableFirst :: Traversable First
40-
instance traversableLast :: Traversable Last
41-
instance traversableAdditive :: Traversable Additive
42-
instance traversableDual :: Traversable Dual
43-
instance traversableConj :: Traversable Conj
44-
instance traversableDisj :: Traversable Disj
45-
instance traversableMultiplicative :: Traversable Multiplicative
37+
Traversable Array
38+
Traversable Maybe
39+
Traversable First
40+
Traversable Last
41+
Traversable Additive
42+
Traversable Dual
43+
Traversable Conj
44+
Traversable Disj
45+
Traversable Multiplicative
4646
```
4747

4848
#### `traverseDefault`

0 commit comments

Comments
 (0)