@@ -13,7 +13,7 @@ module TaskSeq =
13
13
/// Creates a <see cref="taskSeq" /> sequence from <paramref name="source" /> that generates a single element and then ends.
14
14
/// </summary>
15
15
///
16
- /// <param name="value">The input item to use as the single value for the task sequence.</param>
16
+ /// <param name="value">The input item to use as the single item of the task sequence.</param>
17
17
val singleton : value : 'T -> taskSeq < 'T >
18
18
19
19
/// <summary>
@@ -35,11 +35,11 @@ module TaskSeq =
35
35
36
36
/// <summary>
37
37
/// Returns the length of the sequence, or <paramref name="max" />, whichever comes first. This operation requires the task sequence
38
- /// to be evaluated in full, or until <paramref name="max" /> items have been processed. Use this method instead of
39
- /// <see cref="TaskSeq.length" /> if you want to prevent too many items to be evaluated, or if the sequence is potentially infinite.
38
+ /// to be evaluated ether in full, or until <paramref name="max" /> items have been processed. Use this method instead of
39
+ /// <see cref="TaskSeq.length" /> if you need to limit the number of items evaluated, or if the sequence is potentially infinite.
40
40
/// </summary>
41
41
///
42
- /// <param name="max">The maximum value to return and the maximum items to count .</param>
42
+ /// <param name="max">Limit at which to stop evaluating source items for finding the length .</param>
43
43
/// <param name="source">The input task sequence.</param>
44
44
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
45
45
val lengthOrMax : max : int -> source : taskSeq < 'T > -> Task < int >
@@ -76,7 +76,7 @@ module TaskSeq =
76
76
77
77
/// <summary>
78
78
/// Generates a new task sequence which, when iterated, will return successive elements by calling the given function
79
- /// with the current index, up to the given count. Each element is saved after its initialization for successive access to
79
+ /// with the curren zero-basedt index, up to the given count. Each element is saved after its initialization for successive access to
80
80
/// <see cref="IAsyncEnumerator.Current" />, which will not re-evaluate the <paramref name="initializer" />. However,
81
81
/// re-iterating the returned task sequence will re-evaluate the initialization function. The returned sequence may
82
82
/// be passed between threads safely. However, individual IEnumerator values generated from the returned sequence should
@@ -91,7 +91,7 @@ module TaskSeq =
91
91
92
92
/// <summary>
93
93
/// Generates a new task sequence which, when iterated, will return successive elements by calling the given function
94
- /// with the current index, up to the given count. Each element is saved after its initialization for successive access to
94
+ /// with the current zero-based index, up to the given count. Each element is saved after its initialization for successive access to
95
95
/// <see cref="IAsyncEnumerator.Current" />, which will not re-evaluate the <paramref name="initializer" />. However,
96
96
/// re-iterating the returned task sequence will re-evaluate the initialization function. The returned sequence may
97
97
/// be passed between threads safely. However, individual IEnumerator values generated from the returned sequence should
@@ -106,7 +106,7 @@ module TaskSeq =
106
106
107
107
/// <summary>
108
108
/// Generates a new task sequence which, when iterated, will return successive elements by calling the given function
109
- /// with the current index, ad infinitum, or until <see cref="Int32.MaxValue" /> is reached.
109
+ /// with the current zero-based index, ad infinitum, or until <see cref="Int32.MaxValue" /> is reached.
110
110
/// Each element is saved after its initialization for successive access to
111
111
/// <see cref="IAsyncEnumerator.Current" />, which will not re-evaluate the <paramref name="initializer" />. However,
112
112
/// re-iterating the returned task sequence will re-evaluate the initialization function. The returned sequence may
@@ -120,7 +120,7 @@ module TaskSeq =
120
120
121
121
/// <summary>
122
122
/// Generates a new task sequence which, when iterated, will return successive elements by calling the given function
123
- /// with the current index, ad infinitum, or until <see cref="Int32.MaxValue" /> is reached.
123
+ /// with the current zero-based index, ad infinitum, or until <see cref="Int32.MaxValue" /> is reached.
124
124
/// Each element is saved after its initialization for successive access to
125
125
/// <see cref="IAsyncEnumerator.Current" />, which will not re-evaluate the <paramref name="initializer" />. However,
126
126
/// re-iterating the returned task sequence will re-evaluate the initialization function. The returned sequence may
@@ -208,7 +208,7 @@ module TaskSeq =
208
208
val toSeq : source : taskSeq < 'T > -> seq < 'T >
209
209
210
210
/// <summary>
211
- /// Builds an <see cref="array" /> asynchronously from the input task sequence in <paramref name="source" /> .
211
+ /// Builds an <see cref="array" /> asynchronously from the input task sequence.
212
212
/// This function is non-blocking while it builds the array.
213
213
/// </summary>
214
214
///
@@ -218,7 +218,7 @@ module TaskSeq =
218
218
val toArrayAsync : source : taskSeq < 'T > -> Task < 'T []>
219
219
220
220
/// <summary>
221
- /// Builds an F# <see cref="list" /> asynchronously from the input task sequence in <paramref name="source" /> .
221
+ /// Builds an F# <see cref="list" /> asynchronously from the input task sequence.
222
222
/// This function is non-blocking while it builds the list.
223
223
/// </summary>
224
224
///
@@ -228,7 +228,7 @@ module TaskSeq =
228
228
val toListAsync : source : taskSeq < 'T > -> Task < 'T list >
229
229
230
230
/// <summary>
231
- /// Builds a resizable array asynchronously from the input task sequence in <paramref name="source" /> .
231
+ /// Gathers items into a ResizeArray (see <see cref="T:System.Collections.Generic.List<_>" />) asynchronously from the input task sequence.
232
232
/// This function is non-blocking while it builds the resizable array.
233
233
/// </summary>
234
234
///
@@ -238,7 +238,7 @@ module TaskSeq =
238
238
val toResizeArrayAsync : source : taskSeq < 'T > -> Task < ResizeArray < 'T >>
239
239
240
240
/// <summary>
241
- /// Builds an <see cref="IList<'T>" /> asynchronously from the input task sequence in <paramref name="source" /> .
241
+ /// Builds an <see cref="IList<'T>" /> asynchronously from the input task sequence.
242
242
/// This function is non-blocking while it builds the IList.
243
243
/// </summary>
244
244
///
@@ -404,7 +404,7 @@ module TaskSeq =
404
404
405
405
/// <summary>
406
406
/// Iterates over the input task sequence, applying the <paramref name="action" /> function to each item,
407
- /// carrying the index as extra parameter for the <paramref name="action" /> function.
407
+ /// supplying the zero-based index as extra parameter for the <paramref name="action" /> function.
408
408
/// This function is non-blocking, but will exhaust the full input sequence as soon as the task is evaluated.
409
409
/// </summary>
410
410
///
@@ -427,7 +427,7 @@ module TaskSeq =
427
427
428
428
/// <summary>
429
429
/// Iterates over the input task sequence, applying the asynchronous <paramref name="action" /> function to each item,
430
- /// carrying the index as extra parameter for the <paramref name="action" /> function.
430
+ /// supplying the zero-based index as extra parameter for the <paramref name="action" /> function.
431
431
/// This function is non-blocking, but will exhaust the full input sequence as soon as the task is evaluated.
432
432
/// </summary>
433
433
///
@@ -451,7 +451,7 @@ module TaskSeq =
451
451
/// <summary>
452
452
/// Builds a new task sequence whose elements are the results of applying the <paramref name="action" />
453
453
/// function to each of the elements of the input task sequence in <paramref name="source" />.
454
- /// The given function will be applied as elements are demanded using the <see cref="MoveNextAsync" />
454
+ /// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
455
455
/// method on async enumerators retrieved from the input task sequence.
456
456
/// Does not evaluate the input sequence until requested.
457
457
/// </summary>
@@ -465,8 +465,8 @@ module TaskSeq =
465
465
/// <summary>
466
466
/// Builds a new task sequence whose elements are the results of applying the <paramref name="action" />
467
467
/// function to each of the elements of the input task sequence in <paramref name="source" />, passing
468
- /// an extra index argument to the <paramref name="action" /> function.
469
- /// The given function will be applied as elements are demanded using the <see cref="MoveNextAsync" />
468
+ /// an extra zero-based index argument to the <paramref name="action" /> function.
469
+ /// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
470
470
/// method on async enumerators retrieved from the input task sequence.
471
471
/// Does not evaluate the input sequence until requested.
472
472
/// </summary>
@@ -480,7 +480,7 @@ module TaskSeq =
480
480
/// <summary>
481
481
/// Builds a new task sequence whose elements are the results of applying the asynchronous <paramref name="action" />
482
482
/// function to each of the elements of the input task sequence in <paramref name="source" />.
483
- /// The given function will be applied as elements are demanded using the <see cref="MoveNextAsync" />
483
+ /// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
484
484
/// method on async enumerators retrieved from the input task sequence.
485
485
/// Does not evaluate the input sequence until requested.
486
486
/// </summary>
@@ -494,8 +494,8 @@ module TaskSeq =
494
494
/// <summary>
495
495
/// Builds a new task sequence whose elements are the results of applying the asynchronous <paramref name="action" />
496
496
/// function to each of the elements of the input task sequence in <paramref name="source" />, passing
497
- /// an extra index argument to the <paramref name="action" /> function.
498
- /// The given function will be applied as elements are demanded using the <see cref="MoveNextAsync" />
497
+ /// an extra zero-based index argument to the <paramref name="action" /> function.
498
+ /// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
499
499
/// method on async enumerators retrieved from the input task sequence.
500
500
/// Does not evaluate the input sequence until requested.
501
501
/// </summary>
@@ -510,7 +510,7 @@ module TaskSeq =
510
510
/// Builds a new task sequence whose elements are the results of applying the <paramref name="binder" />
511
511
/// function to each of the elements of the input task sequence in <paramref name="source" />, and concatenating the
512
512
/// returned task sequences.
513
- /// The given function will be applied as elements are demanded using the <see cref="MoveNextAsync" />
513
+ /// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
514
514
/// method on async enumerators retrieved from the input task sequence.
515
515
/// Does not evaluate the input sequence until requested.
516
516
/// </summary>
@@ -525,7 +525,7 @@ module TaskSeq =
525
525
/// Builds a new task sequence whose elements are the results of applying the <paramref name="binder" />
526
526
/// function to each of the elements of the input task sequence in <paramref name="source" />, and concatenating the
527
527
/// returned regular F# sequences.
528
- /// The given function will be applied as elements are demanded using the <see cref="MoveNextAsync" />
528
+ /// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
529
529
/// method on async enumerators retrieved from the input task sequence.
530
530
/// Does not evaluate the input sequence until requested.
531
531
/// </summary>
@@ -540,7 +540,7 @@ module TaskSeq =
540
540
/// Builds a new task sequence whose elements are the results of applying the asynchronous <paramref name="binder" />
541
541
/// function to each of the elements of the input task sequence in <paramref name="source" />, and concatenating the
542
542
/// returned task sequences.
543
- /// The given function will be applied as elements are demanded using the <see cref="MoveNextAsync" />
543
+ /// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
544
544
/// method on async enumerators retrieved from the input task sequence.
545
545
/// Does not evaluate the input sequence until requested.
546
546
/// </summary>
@@ -555,7 +555,7 @@ module TaskSeq =
555
555
/// Builds a new task sequence whose elements are the results of applying the asynchronous <paramref name="binder" />
556
556
/// function to each of the elements of the input task sequence in <paramref name="source" />, and concatenating the
557
557
/// returned regular F# sequences.
558
- /// The given function will be applied as elements are demanded using the <see cref="MoveNextAsync" />
558
+ /// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
559
559
/// method on async enumerators retrieved from the input task sequence.
560
560
/// Does not evaluate the input sequence until requested.
561
561
/// </summary>
@@ -577,7 +577,7 @@ module TaskSeq =
577
577
val tryHead : source : taskSeq < 'T > -> Task < 'T option >
578
578
579
579
/// <summary>
580
- /// Returns the first elementof the input task sequence given by <paramref name="source" />.
580
+ /// Returns the first element of the input task sequence given by <paramref name="source" />.
581
581
/// </summary>
582
582
///
583
583
/// <param name="source">The input task sequence.</param>
@@ -628,8 +628,7 @@ module TaskSeq =
628
628
629
629
/// <summary>
630
630
/// Returns the nth element of the input task sequence given by <paramref name="source" />,
631
- /// or <see cref="None" /> if the sequence does not contain enough elements, or <paramref name="index" />
632
- /// is negative.
631
+ /// or <see cref="None" /> if the sequence does not contain enough elements.
633
632
/// The index is zero-based, that is, using index 0 returns the first element.
634
633
/// </summary>
635
634
///
@@ -640,8 +639,7 @@ module TaskSeq =
640
639
641
640
/// <summary>
642
641
/// Returns the nth element of the input task sequence given by <paramref name="source" />,
643
- /// or raises an exception if the sequence does not contain enough elements, or <paramref name="index" />
644
- /// is negative.
642
+ /// or raises an exception if the sequence does not contain enough elements.
645
643
/// The index is zero-based, that is, using index 0 returns the first element.
646
644
/// </summary>
647
645
///
@@ -823,7 +821,7 @@ module TaskSeq =
823
821
val tryFindAsync : predicate : ( 'T -> #Task < bool >) -> source : taskSeq < 'T > -> Task < 'T option >
824
822
825
823
/// <summary>
826
- /// Returns the index, starting from zero for which the given function <paramref name="predicate" /> returns
824
+ /// Returns the index, starting from zero, for which the given function <paramref name="predicate" /> returns
827
825
/// <see cref="true" />. Returns <see cref="None" /> if no such element exists.
828
826
/// If <paramref name="predicate" /> is asynchronous, consider using <see cref="TaskSeq.tryFindIndexAsync" />.
829
827
/// </summary>
@@ -835,7 +833,7 @@ module TaskSeq =
835
833
val tryFindIndex : predicate : ( 'T -> bool ) -> source : taskSeq < 'T > -> Task < int option >
836
834
837
835
/// <summary>
838
- /// Returns the index, starting from zero for which the given asynchronous function <paramref name="predicate" /> returns
836
+ /// Returns the index, starting from zero, for which the given asynchronous function <paramref name="predicate" /> returns
839
837
/// <see cref="true" />. Returns <see cref="None" /> if no such element exists.
840
838
/// If <paramref name="predicate" /> is synchronous, consider using <see cref="TaskSeq.tryFindIndex" />.
841
839
/// </summary>
0 commit comments