Skip to content

Commit

Permalink
Update readme.md and package files for max|min etc
Browse files Browse the repository at this point in the history
  • Loading branch information
abelbraaksma committed Dec 23, 2023
1 parent 9a165f1 commit 2e9541c
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 9 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,10 +289,10 @@ This is what has been implemented so far, is planned or skipped:
| 🚫 | `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.") |
| ✅ [#2][] | `mapi` | `mapi` | `mapiAsync` | |
| | `mapi2` | `mapi2` | `mapi2Async` | |
| | `max` | `max` | | |
| | `maxBy` | `maxBy` | `maxByAsync` | |
| | `min` | `min` | | |
| | `minBy` | `minBy` | `minByAsync` | |
| ✅ [#221][]| `max` | `max` | | |
| ✅ [#221][]| `maxBy` | `maxBy` | `maxByAsync` | |
| ✅ [#221][]| `min` | `min` | | |
| ✅ [#221][]| `minBy` | `minBy` | `minByAsync` | |
| ✅ [#2][] | `ofArray` | `ofArray` | | |
| ✅ [#2][] | | `ofAsyncArray` | | |
| ✅ [#2][] | | `ofAsyncList` | | |
Expand Down Expand Up @@ -511,7 +511,12 @@ module TaskSeq =
val mapAsync: mapper: ('T -> #Task<'U>) -> source: TaskSeq<'T> -> TaskSeq<'U>
val mapi: mapper: (int -> 'T -> 'U) -> source: TaskSeq<'T> -> TaskSeq<'U>
val mapiAsync: mapper: (int -> 'T -> #Task<'U>) -> source: TaskSeq<'T> -> TaskSeq<'U>
val ofArray: source: 'T[] -> TaskSeq<'T>
val max: source: TaskSeq<'T> -> Task<'T> when 'T: comparison
val max: source: TaskSeq<'T> -> Task<'T> when 'T: comparison
val maxBy: projection: ('T -> 'U) -> source: TaskSeq<'T> -> Task<'T> when 'U: comparison
val minBy: projection: ('T -> 'U) -> source: TaskSeq<'T> -> Task<'T> when 'U: comparison
val maxByAsync: projection: ('T -> #Task<'U>) -> source: TaskSeq<'T> -> Task<'T> when 'U: comparison
val minByAsync: projection: ('T -> #Task<'U>) -> source: TaskSeq<'T> -> Task<'T> when 'U: comparison val ofArray: source: 'T[] -> TaskSeq<'T>
val ofAsyncArray: source: Async<'T> array -> TaskSeq<'T>
val ofAsyncList: source: Async<'T> list -> TaskSeq<'T>
val ofAsyncSeq: source: seq<Async<'T>> -> TaskSeq<'T>
Expand Down Expand Up @@ -604,6 +609,7 @@ module TaskSeq =
[#209]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/209
[#217]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/217
[#219]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/219
[#221]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/221

[issues]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues
[nuget]: https://www.nuget.org/packages/FSharp.Control.TaskSeq/
9 changes: 5 additions & 4 deletions assets/nuget-package-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,10 @@ This is what has been implemented so far, is planned or skipped:
| &#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.") |
| &#x2705; [#2][] | `mapi` | `mapi` | `mapiAsync` | |
| | `mapi2` | `mapi2` | `mapi2Async` | |
| | `max` | `max` | | |
| | `maxBy` | `maxBy` | `maxByAsync` | |
| | `min` | `min` | | |
| | `minBy` | `minBy` | `minByAsync` | |
| &#x2705; [#221][]| `max` | `max` | | |
| &#x2705; [#221][]| `maxBy` | `maxBy` | `maxByAsync` | |
| &#x2705; [#221][]| `min` | `min` | | |
| &#x2705; [#221][]| `minBy` | `minBy` | `minByAsync` | |
| &#x2705; [#2][] | `ofArray` | `ofArray` | | |
| &#x2705; [#2][] | | `ofAsyncArray` | | |
| &#x2705; [#2][] | | `ofAsyncList` | | |
Expand Down Expand Up @@ -309,3 +309,4 @@ _The motivation for `readOnly` in `Seq` is that a cast from a mutable array or l
[#209]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/209
[#217]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/217
[#219]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/219
[#221]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/221
1 change: 1 addition & 0 deletions release-notes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Release notes:
* TaskSeq.truncate, drop, #209
* TaskSeq.where, whereAsync, #217
* TaskSeq.skipWhile, skipWhileInclusive, skipWhileAsync, skipWhileInclusiveAsync, #219
* TaskSeq.max, min, maxBy, minBy, maxByAsync, minByAsync, #221

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

0 comments on commit 2e9541c

Please sign in to comment.