diff --git a/src/FSharp.Control.TaskSeq/TaskSeq.fsi b/src/FSharp.Control.TaskSeq/TaskSeq.fsi index dd1124b..97aebeb 100644 --- a/src/FSharp.Control.TaskSeq/TaskSeq.fsi +++ b/src/FSharp.Control.TaskSeq/TaskSeq.fsi @@ -547,10 +547,9 @@ type TaskSeq = /// Builds a new task sequence whose elements are the results of applying the /// function to each of the elements of the input task sequence in , passing /// an extra zero-based index argument to the function. - /// The given function will be applied as elements are pulled using async enumerators retrieved from the - /// input task sequence. - /// - /// If is asynchronous, use . + /// The given function will be applied as elements are pulled using the + /// method on async enumerators retrieved from the input task sequence. + /// Does not evaluate the input sequence until requested. /// /// /// A function to transform items from the input task sequence that also access the current index. @@ -578,10 +577,9 @@ type TaskSeq = /// Builds a new task sequence whose elements are the results of applying the asynchronous /// function to each of the elements of the input task sequence in , passing /// an extra zero-based index argument to the function. - /// The given function will be applied as elements are pulled using async enumerators retrieved from the - /// input task sequence. - /// - /// If is synchronous, use . + /// The given function will be applied as elements are pulled using the + /// method on async enumerators retrieved from the input task sequence. + /// Does not evaluate the input sequence until requested. /// /// /// An asynchronous function to transform items from the input task sequence that also access the current index. @@ -959,9 +957,9 @@ type TaskSeq = /// /// Returns a task sequence that, when iterated, skips elements of the underlying sequence while the /// given function returns , and then yields the remaining - /// elements. The first element where the predicate returns is returned, which means that this - /// function will skip 0 or more elements (see also ). - /// If is asynchronous, use . + /// elements. Elements where the predicate returns are propagated, which means that this + /// function may not skip any elements (see also ). + /// If is asynchronous, consider using . /// /// /// A function that evaluates to false when no more items should be skipped. @@ -973,9 +971,9 @@ type TaskSeq = /// /// Returns a task sequence that, when iterated, skips elements of the underlying sequence while the /// given asynchronous function returns , and then yields the - /// remaining elements. The first element where the predicate returns is returned, which - /// means that this function will skip 0 or more elements (see also ). - /// If is synchronous, use . + /// remaining elements. Elements where the predicate returns are propagated, which means that this + /// function may not skip any elements (see also ). + /// If is synchronous, consider using . /// /// /// An asynchronous function that evaluates to false when no more items should be skipped. @@ -986,13 +984,13 @@ type TaskSeq = /// /// Returns a task sequence that, when iterated, skips elements of the underlying sequence until the given - /// function returns , also skips that element - /// and then yields the remaining elements (see also ). This function skips + /// function returns , also skips that element + /// and then yields the remaining elements (see also ). It will thus always skip /// at least one element of a non-empty sequence, or returns the empty task sequence if the input is empty. /// If is asynchronous, use . /// ` /// - /// A function that evaluates to false when no more items should be skipped. + /// A function that evaluates to false for the final item to be skipped. /// The input task sequence. /// The resulting task sequence. /// Thrown when the input task sequence is null. @@ -1000,13 +998,13 @@ type TaskSeq = /// /// Returns a task sequence that, when iterated, skips elements of the underlying sequence until the given - /// function returns , also skips that element - /// and then yields the remaining elements (see also ). This function skips + /// function returns , also skips that element + /// and then yields the remaining elements (see also ). It will thus always skip /// at least one element of a non-empty sequence, or returns the empty task sequence if the input is empty. /// If is synchronous, use . /// /// - /// An asynchronous function that evaluates to false when no more items should be skipped. + /// An asynchronous function that evaluates to false for the final item to be skipped. /// The input task sequence. /// The resulting task sequence. /// Thrown when the input task sequence is null. @@ -1248,6 +1246,9 @@ type TaskSeq = /// /// Applies the function to each element in the task sequence, threading an accumulator + /// argument of type through the computation. If the input function is f and the elements are i0...iN + /// then computes f (... (f s i0)...) iN. + /// If the accumulator function is asynchronous, consider using . /// argument of type through the computation. If the input function is and the elements are /// then computes . /// If the accumulator function is asynchronous, use . @@ -1264,7 +1265,7 @@ type TaskSeq = /// Applies the asynchronous function to each element in the task sequence, threading an accumulator /// argument of type through the computation. If the input function is and the elements are /// then computes . - /// If the accumulator function is synchronous, use . + /// If the accumulator function is synchronous, consider using . /// /// /// A function that updates the state with each element from the sequence.