Skip to content

Commit e128340

Browse files
committed
Add TOC
1 parent 30f9f00 commit e128340

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

+24
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,29 @@ An implementation [`IAsyncEnumerable<'T>`][3] as a `taskSeq` CE for F# with acco
77

88
The `IAsyncEnumerable` interface was added to .NET in `.NET Core 3.0` and is part of `.NET Standard 2.1`. The main use-case was for iterative asynchronous enumeration over some resource. For instance, an event stream or a REST API interface with pagination, where each page is a [`MoveNextAsync`][4] call on the [`IAsyncEnumerator<'T>`][5] given by a call to [`GetAsyncEnumerator()`][6]. It has been relatively challenging to work properly with this type and dealing with each step being asynchronous, and the enumerator implementing [`IAsyncDisposable`][7] as well, which requires careful handling.
99

10+
-----------------------------------------
11+
12+
## Table of contents
13+
14+
- [Short-term feature planning](#short-term-feature-planning)
15+
- [Implementation progress](#implementation-progress)
16+
- [`taskSeq` CE](#taskseq-ce)
17+
- [`TaskSeq` module functions](#taskseq-module-functions)
18+
- [Futher reading `IAsyncEnumerable`](#futher-reading-iasyncenumerable)
19+
- [Futher reading on resumable state machines](#futher-reading-on-resumable-state-machines)
20+
- [Further reading on computation expressions](#further-reading-on-computation-expressions)
21+
- [Building & testing](#building--testing)
22+
- [Prerequisites](#prerequisites)
23+
- [Build the solution](#build-the-solution)
24+
- [Run the tests](#run-the-tests)
25+
- [Run the CI command](#run-the-ci-command)
26+
- [Advanced](#advanced)
27+
- [Get help (duh!)](#get-help-duh)
28+
- [In progress!!!](#in-progress)
29+
- [Current set of `TaskSeq` utility functions](#current-set-of-taskseq-utility-functions)
30+
31+
-----------------------------------------
32+
1033
## Short-term feature planning
1134

1235
Not necessarily in order of importance:
@@ -15,6 +38,7 @@ Not necessarily in order of importance:
1538
* [x] A growing set of module functions `TaskSeq`, see below for progress. **DONE & IN PROGRESS**
1639
* [ ] Packaging and publishing on Nuget, **PLANNED: 13 November 2022**.
1740
* [x] Add `Async` variants for functions taking HOF arguments. **DONE**
41+
* [ ] Add generated docs to <https://fsprojects.github.io>
1842
* [ ] Expand surface area based on `AsyncSeq`.
1943
* [ ] User requests?
2044

0 commit comments

Comments
 (0)