Skip to content

Commit 6311817

Browse files
committed
Update readme.md package readme and release notes
1 parent 3bfedca commit 6311817

File tree

3 files changed

+13
-10
lines changed

3 files changed

+13
-10
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ The _resumable state machine_ backing the `taskSeq` CE is now finished and _rest
225225

226226
We are working hard on getting a full set of module functions on `TaskSeq` that can be used with `IAsyncEnumerable` sequences. Our guide is the set of F# `Seq` functions in F# Core and, where applicable, the functions provided by `AsyncSeq`. Each implemented function is documented through XML doc comments to provide the necessary context-sensitive help.
227227

228-
The following is the progress report:
228+
This is what has been implemented so far, is planned or skipped:
229229

230230
| Done | `Seq` | `TaskSeq` | Variants | Remarks |
231231
|------------------|--------------------|----------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -353,7 +353,7 @@ The following is the progress report:
353353
| ✅ [#76][] | | `tryTail` | | |
354354
| | `unfold` | `unfold` | `unfoldAsync` | |
355355
| | `updateAt` | `updateAt` | | |
356-
| | `where` | `where` | `whereAsync` | |
356+
| ✅ [#217][]| `where` | `where` | `whereAsync` | |
357357
| | `windowed` | `windowed` | | |
358358
| ✅ [#2][] | `zip` | `zip` | | |
359359
| | `zip3` | `zip3` | | |
@@ -551,6 +551,8 @@ module TaskSeq =
551551
val tryPick: chooser: ('T -> 'U option) -> source: TaskSeq<'T> -> Task<'U option>
552552
val tryPickAsync: chooser: ('T -> #Task<'U option>) -> source: TaskSeq<'T> -> Task<'U option>
553553
val tryTail: source: TaskSeq<'T> -> Task<TaskSeq<'T> option>
554+
val where: predicate: ('T -> bool) -> source: TaskSeq<'T> -> TaskSeq<'T>
555+
val whereAsync: predicate: ('T -> #Task<bool>) -> source: TaskSeq<'T> -> TaskSeq<'T>
554556
val unbox<'U when 'U: struct> : source: TaskSeq<obj> -> TaskSeq<'U>
555557
val zip: source1: TaskSeq<'T> -> source2: TaskSeq<'U> -> TaskSeq<'T * 'U>
556558
```
@@ -600,6 +602,7 @@ module TaskSeq =
600602
[#126]: https://github.com/fsprojects/FSharp.Control.TaskSeq/pull/126
601603
[#133]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/133
602604
[#209]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/209
605+
[#217]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/217
603606

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

assets/nuget-package-readme.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,9 @@ let feedFromTwitter user pwd = taskSeq {
103103

104104
### `TaskSeq` module functions
105105

106-
We are working hard on getting a full set of module functions on `TaskSeq` that can be used with `IAsyncEnumerable` sequences. Our guide is the set of F# `Seq` functions in F# Core and, where applicable, the functions provided from `AsyncSeq`. Each implemented function is documented through XML doc comments to provide the necessary context-sensitive help.
107-
108106
We are working hard on getting a full set of module functions on `TaskSeq` that can be used with `IAsyncEnumerable` sequences. Our guide is the set of F# `Seq` functions in F# Core and, where applicable, the functions provided by `AsyncSeq`. Each implemented function is documented through XML doc comments to provide the necessary context-sensitive help.
109107

110-
This is what was implemented, planned or skipped:
108+
This is what has been implemented so far, is planned or skipped:
111109

112110
| Done | `Seq` | `TaskSeq` | Variants | Remarks |
113111
|------------------|--------------------|----------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -235,7 +233,7 @@ This is what was implemented, planned or skipped:
235233
| &#x2705; [#76][] | | `tryTail` | | |
236234
| | `unfold` | `unfold` | `unfoldAsync` | |
237235
| | `updateAt` | `updateAt` | | |
238-
| | `where` | `where` | `whereAsync` | |
236+
| &#x2705; [#217][]| `where` | `where` | `whereAsync` | |
239237
| | `windowed` | `windowed` | | |
240238
| &#x2705; [#2][] | `zip` | `zip` | | |
241239
| | `zip3` | `zip3` | | |
@@ -308,4 +306,5 @@ _The motivation for `readOnly` in `Seq` is that a cast from a mutable array or l
308306
[#83]: https://github.com/fsprojects/FSharp.Control.TaskSeq/pull/83
309307
[#90]: https://github.com/fsprojects/FSharp.Control.TaskSeq/pull/90
310308
[#126]: https://github.com/fsprojects/FSharp.Control.TaskSeq/pull/126
311-
[#209]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/209
309+
[#209]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/209
310+
[#217]: https://github.com/fsprojects/FSharp.Control.TaskSeq/issues/217

release-notes.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,23 @@ Release notes:
55
- new surface area functions, fixes #208:
66
* TaskSeq.take, TaskSeq.skip, #209
77
* TaskSeq.truncate, TaskSeq.drop, #209
8+
* TaskSeq.where, TaskSeq.whereAsync, #217
89

910
- Performance: less thread hops with 'StartImmediateAsTask' instead of 'StartAsTask', fixes #135
1011
- BINARY INCOMPATIBILITY: 'TaskSeq' module is now static members on 'TaskSeq<_>', fixes #184
11-
- DEPRECATIONS (warning FS0044):
12+
- DEPRECATIONS (warning FS0044):
1213
- type 'taskSeq<_>' is renamed to 'TaskSeq<_>', fixes #193
1314
- function 'ValueTask.ofIValueTaskSource` renamed to `ValueTask.ofSource`, fixes #193
1415
- function `ValueTask.FromResult` is renamed to `ValueTask.fromResult`, fixes #193
15-
16+
1617
0.4.0-alpha.1
1718
- fixes not calling Dispose for 'use!', 'use', or `finally` blocks #157 (by @bartelink)
1819
- BREAKING CHANGE: null args now raise ArgumentNullException instead of NullReferenceException, #127
1920
- adds `let!` and `do!` support for F#'s Async<'T>, #79, #114
2021
- adds TaskSeq.takeWhile, takeWhileAsync, takeWhileInclusive, takeWhileInclusiveAsync, #126 (by @bartelink)
2122
- adds AsyncSeq vs TaskSeq comparison chart, #131
2223
- removes release-notes.txt from file dependencies, but keep in the package, #138
23-
24+
2425
0.3.0
2526
- internal renames, improved doc comments, signature files for complex types, hide internal-only types, fixes #112.
2627
- adds support for static TaskLike, allowing the same let! and do! overloads that F# task supports, fixes #110.

0 commit comments

Comments
 (0)