Skip to content

Commit 2e9541c

Browse files
committed
Update readme.md and package files for max|min etc
1 parent 9a165f1 commit 2e9541c

File tree

3 files changed

+17
-9
lines changed

3 files changed

+17
-9
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -289,10 +289,10 @@ This is what has been implemented so far, is planned or skipped:
289289
| 🚫 | `mapFoldBack` | | | [note #2](#note2 "Because of the async nature of TaskSeq sequences, iterating from the back would be bad practice. Instead, materialize the sequence to a list or array and then apply the 'Back' iterators.") |
290290
| ✅ [#2][] | `mapi` | `mapi` | `mapiAsync` | |
291291
| | `mapi2` | `mapi2` | `mapi2Async` | |
292-
| | `max` | `max` | | |
293-
| | `maxBy` | `maxBy` | `maxByAsync` | |
294-
| | `min` | `min` | | |
295-
| | `minBy` | `minBy` | `minByAsync` | |
292+
| ✅ [#221][]| `max` | `max` | | |
293+
| ✅ [#221][]| `maxBy` | `maxBy` | `maxByAsync` | |
294+
| ✅ [#221][]| `min` | `min` | | |
295+
| ✅ [#221][]| `minBy` | `minBy` | `minByAsync` | |
296296
| ✅ [#2][] | `ofArray` | `ofArray` | | |
297297
| ✅ [#2][] | | `ofAsyncArray` | | |
298298
| ✅ [#2][] | | `ofAsyncList` | | |
@@ -511,7 +511,12 @@ module TaskSeq =
511511
val mapAsync: mapper: ('T -> #Task<'U>) -> source: TaskSeq<'T> -> TaskSeq<'U>
512512
val mapi: mapper: (int -> 'T -> 'U) -> source: TaskSeq<'T> -> TaskSeq<'U>
513513
val mapiAsync: mapper: (int -> 'T -> #Task<'U>) -> source: TaskSeq<'T> -> TaskSeq<'U>
514-
val ofArray: source: 'T[] -> TaskSeq<'T>
514+
val max: source: TaskSeq<'T> -> Task<'T> when 'T: comparison
515+
val max: source: TaskSeq<'T> -> Task<'T> when 'T: comparison
516+
val maxBy: projection: ('T -> 'U) -> source: TaskSeq<'T> -> Task<'T> when 'U: comparison
517+
val minBy: projection: ('T -> 'U) -> source: TaskSeq<'T> -> Task<'T> when 'U: comparison
518+
val maxByAsync: projection: ('T -> #Task<'U>) -> source: TaskSeq<'T> -> Task<'T> when 'U: comparison
519+
val minByAsync: projection: ('T -> #Task<'U>) -> source: TaskSeq<'T> -> Task<'T> when 'U: comparison val ofArray: source: 'T[] -> TaskSeq<'T>
515520
val ofAsyncArray: source: Async<'T> array -> TaskSeq<'T>
516521
val ofAsyncList: source: Async<'T> list -> TaskSeq<'T>
517522
val ofAsyncSeq: source: seq<Async<'T>> -> TaskSeq<'T>
@@ -604,6 +609,7 @@ module TaskSeq =
604609
[#209]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/209
605610
[#217]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/217
606611
[#219]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/219
612+
[#221]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/221
607613

608614
[issues]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues
609615
[nuget]: https://www.nuget.org/packages/FSharp.Control.TaskSeq/

assets/nuget-package-readme.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,10 +169,10 @@ This is what has been implemented so far, is planned or skipped:
169169
| &#x1f6ab; | `mapFoldBack` | | | [note #2](#note2 "Because of the async nature of TaskSeq sequences, iterating from the back would be bad practice. Instead, materialize the sequence to a list or array and then apply the 'Back' iterators.") |
170170
| &#x2705; [#2][] | `mapi` | `mapi` | `mapiAsync` | |
171171
| | `mapi2` | `mapi2` | `mapi2Async` | |
172-
| | `max` | `max` | | |
173-
| | `maxBy` | `maxBy` | `maxByAsync` | |
174-
| | `min` | `min` | | |
175-
| | `minBy` | `minBy` | `minByAsync` | |
172+
| &#x2705; [#221][]| `max` | `max` | | |
173+
| &#x2705; [#221][]| `maxBy` | `maxBy` | `maxByAsync` | |
174+
| &#x2705; [#221][]| `min` | `min` | | |
175+
| &#x2705; [#221][]| `minBy` | `minBy` | `minByAsync` | |
176176
| &#x2705; [#2][] | `ofArray` | `ofArray` | | |
177177
| &#x2705; [#2][] | | `ofAsyncArray` | | |
178178
| &#x2705; [#2][] | | `ofAsyncList` | | |
@@ -309,3 +309,4 @@ _The motivation for `readOnly` in `Seq` is that a cast from a mutable array or l
309309
[#209]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/209
310310
[#217]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/217
311311
[#219]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/219
312+
[#221]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/221

release-notes.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Release notes:
77
* TaskSeq.truncate, drop, #209
88
* TaskSeq.where, whereAsync, #217
99
* TaskSeq.skipWhile, skipWhileInclusive, skipWhileAsync, skipWhileInclusiveAsync, #219
10+
* TaskSeq.max, min, maxBy, minBy, maxByAsync, minByAsync, #221
1011

1112
- Performance: less thread hops with 'StartImmediateAsTask' instead of 'StartAsTask', fixes #135
1213
- BINARY INCOMPATIBILITY: 'TaskSeq' module is now static members on 'TaskSeq<_>', fixes #184

0 commit comments

Comments
 (0)