docs

Author: eulerfx

src/FSharp.Control.AsyncSeq/AsyncSeq.fsi

@@ -208,7 +208,7 @@ module AsyncSeq =
     /// Asynchronously determine if the predicate returns true for all values in the sequence 
     val forall : predicate:('T -> bool) -> source:AsyncSeq<'T> -> Async<bool>
 
-    /// Return an asynhronous sequence which, when iterated, includes an integer indicating the index of each element in the sequence.
+    /// Return an asynchronous sequence which, when iterated, includes an integer indicating the index of each element in the sequence.
     val indexed : source:AsyncSeq<'T> -> AsyncSeq<int64 * 'T>
 
     /// Asynchronously determine the number of elements in the sequence
@@ -371,12 +371,15 @@ module AsyncSeq =
     val bufferByCountAndTime : bufferSize:int -> timeoutMs:int -> source:AsyncSeq<'T> -> AsyncSeq<'T []>
 
     /// Merges two async sequences into an async sequence non-deterministically.
+    /// The resulting async sequence produces elements when any argument sequence produces an element.
     val mergeChoice: source1:AsyncSeq<'T1> -> source2:AsyncSeq<'T2> -> AsyncSeq<Choice<'T1,'T2>>
 
-    /// Merges two async sequences of the same typee into an async sequence non-deterministically.
+    /// Merges two async sequences of the same type into an async sequence non-deterministically.
+    /// The resulting async sequence produces elements when any argument sequence produces an element.
     val merge: source1:AsyncSeq<'T> -> source2:AsyncSeq<'T> -> AsyncSeq<'T>
 
     /// Merges all specified async sequences into an async sequence non-deterministically.
+    /// The resulting async sequence produces elements when any argument sequence produces an element.
     val mergeAll : sources:AsyncSeq<'T> list -> AsyncSeq<'T>
 
     /// Returns an async sequence which contains no contiguous duplicate elements based on the specified comparison function.
@@ -394,30 +397,29 @@ module AsyncSeq =
     /// Builds a new asynchronous sequence whose elements are generated by 
     /// applying the specified function to all elements of the input sequence.
     ///
-    /// The function is applied to elements in order but in parallel - without waiting
-    /// for a prior mapping to complete.
+    /// The function is applied to elements in order and results are emitted in order,
+    /// but in parallel, without waiting for a prior mapping operation to complete. 
+    /// Parallelism is bound by the ThreadPool.
     val mapAsyncParallel : mapping:('T -> Async<'U>) -> s:AsyncSeq<'T> -> AsyncSeq<'U>
 
-    /// Builds a new asynchronous sequence whose elements are generated by 
-    /// applying the specified function to all elements of the input sequence.
-    ///
-    /// The function is applied to elements in order but in parallel - without waiting
-    /// for a prior mapping to complete. Up to the specified number of mappings will
-    /// occur in parallel before non-blocking waiting.
-    val mapAsyncParallelBounded : parallelism:int -> mapping:('T -> Async<'U>) -> s:AsyncSeq<'T> -> AsyncSeq<'U>
-
     /// Applies a key-generating function to each element and returns an async sequence containing unique keys
     /// and async sequences containing elements corresponding to the key.
+    /// 
+    /// Note that the resulting async sequence has to be processed in parallel (e.g AsyncSeq.mapAsyncParallel) becaused
+    /// completion of sub-sequences depends on completion of other sub-sequences.
     val groupByAsync<'T, 'Key when 'Key : equality> : projection:('T -> Async<'Key>) -> source:AsyncSeq<'T> -> AsyncSeq<'Key * AsyncSeq<'T>>
 
     /// Applies a key-generating function to each element and returns an async sequence containing unique keys
     /// and async sequences containing elements corresponding to the key.
+    ///
+    /// Note that the resulting async sequence has to be processed in parallel (e.g AsyncSeq.mapAsyncParallel) becaused
+    /// completion of sub-sequences depends on completion of other sub-sequences.
     val groupBy<'T, 'Key when 'Key : equality> : projection:('T -> 'Key) -> source:AsyncSeq<'T> -> AsyncSeq<'Key * AsyncSeq<'T>>
 
-/// An automatically-opened module tht contains the `asyncSeq` builder and an extension method 
+/// An automatically-opened module that contains the `asyncSeq` builder and an extension method 
 [<AutoOpen>]
 module AsyncSeqExtensions = 
-    /// Builds an asynchronou sequence using the computation builder syntax
+    /// Builds an asynchronous sequence using the computation builder syntax
     val asyncSeq : AsyncSeq.AsyncSeqBuilder
 
     /// Converts asynchronous sequence to a synchronous blocking sequence.

tests/FSharp.Control.AsyncSeq.Tests/AsyncSeqTests.fs

@@ -1147,17 +1147,17 @@ let ``AsyncSeq.mapParallelAsync should be parallel`` () =
   Assert.AreEqual(expected, actual, timeout=200)
 
 //[<Test>]
-let ``AsyncSeq.mapParallelAsyncBounded should maintain order`` () =
-  let ls = List.init 500 id
-  let expected = 
-    ls 
-    |> AsyncSeq.ofSeq
-    |> AsyncSeq.mapAsync (async.Return)
-  let actual = 
-    ls 
-    |> AsyncSeq.ofSeq 
-    |> AsyncSeq.mapAsyncParallelBounded 10 (async.Return)
-  Assert.AreEqual(expected, actual, timeout=200)
+//let ``AsyncSeq.mapParallelAsyncBounded should maintain order`` () =
+//  let ls = List.init 500 id
+//  let expected = 
+//    ls 
+//    |> AsyncSeq.ofSeq
+//    |> AsyncSeq.mapAsync (async.Return)
+//  let actual = 
+//    ls 
+//    |> AsyncSeq.ofSeq 
+//    |> AsyncSeq.mapAsyncParallelBounded 10 (async.Return)
+//  Assert.AreEqual(expected, actual, timeout=200)