Skip to content

Commit f7d142d

Browse files
bartelinkabelbraaksma
authored andcommitted
Fix typos, spelling errors, misnamed paramref in xml docs
1 parent 06bc268 commit f7d142d

File tree

4 files changed

+27
-22
lines changed

4 files changed

+27
-22
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
2+
<s:Boolean x:Key="/Default/UserDictionary/Words/=infinitum/@EntryIndexedValue">True</s:Boolean>
3+
<s:Boolean x:Key="/Default/UserDictionary/Words/=iteri/@EntryIndexedValue">True</s:Boolean>
4+
<s:Boolean x:Key="/Default/UserDictionary/Words/=taskseqs/@EntryIndexedValue">True</s:Boolean>
5+
<s:Boolean x:Key="/Default/UserDictionary/Words/=typeref/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

src/FSharp.Control.TaskSeq/TaskSeq.fs

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -314,15 +314,15 @@ type TaskSeq private () =
314314

315315
static member exists predicate source =
316316
Internal.tryFind (Predicate predicate) source
317-
|> Task.map (Option.isSome)
317+
|> Task.map Option.isSome
318318

319319
static member existsAsync predicate source =
320320
Internal.tryFind (PredicateAsync predicate) source
321-
|> Task.map (Option.isSome)
321+
|> Task.map Option.isSome
322322

323323
static member contains value source =
324324
Internal.tryFind (Predicate((=) value)) source
325-
|> Task.map (Option.isSome)
325+
|> Task.map Option.isSome
326326

327327
static member pick chooser source =
328328
Internal.tryPick (TryPick chooser) source
@@ -348,8 +348,6 @@ type TaskSeq private () =
348348
Internal.tryFindIndex (PredicateAsync predicate) source
349349
|> Task.map (Option.defaultWith Internal.raiseNotFound)
350350

351-
352-
353351
//
354352
// zip/unzip/fold etc functions
355353
//

src/FSharp.Control.TaskSeq/TaskSeq.fsi

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ type TaskSeq =
8181

8282
/// <summary>
8383
/// Generates a new task sequence which, when iterated, will return successive elements by calling the given function
84-
/// with the curren zero-basedt index, up to the given count. Each element is saved after its initialization for successive access to
84+
/// with the current zero-based index, up to the given count. Each element is saved after its initialization for successive access to
8585
/// <see cref="IAsyncEnumerator.Current" />, which will not re-evaluate the <paramref name="initializer" />. However,
8686
/// re-iterating the returned task sequence will re-evaluate the initialization function. The returned sequence may
8787
/// be passed between threads safely. However, individual IEnumerator values generated from the returned sequence should
@@ -454,58 +454,58 @@ type TaskSeq =
454454
static member indexed: source: TaskSeq<'T> -> TaskSeq<int * 'T>
455455

456456
/// <summary>
457-
/// Builds a new task sequence whose elements are the results of applying the <paramref name="action" />
457+
/// Builds a new task sequence whose elements are the results of applying the <paramref name="mapper" />
458458
/// function to each of the elements of the input task sequence in <paramref name="source" />.
459459
/// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
460460
/// method on async enumerators retrieved from the input task sequence.
461461
/// Does not evaluate the input sequence until requested.
462462
/// </summary>
463463
///
464-
/// <param name="mapping">A function to transform items from the input task sequence.</param>
464+
/// <param name="mapper">A function to transform items from the input task sequence.</param>
465465
/// <param name="source">The input task sequence.</param>
466466
/// <returns>The resulting task sequence.</returns>
467467
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
468468
static member map: mapper: ('T -> 'U) -> source: TaskSeq<'T> -> TaskSeq<'U>
469469

470470
/// <summary>
471-
/// Builds a new task sequence whose elements are the results of applying the <paramref name="action" />
471+
/// Builds a new task sequence whose elements are the results of applying the <paramref name="mapper" />
472472
/// function to each of the elements of the input task sequence in <paramref name="source" />, passing
473-
/// an extra zero-based index argument to the <paramref name="action" /> function.
473+
/// an extra zero-based index argument to the <paramref name="mapper" /> function.
474474
/// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
475475
/// method on async enumerators retrieved from the input task sequence.
476476
/// Does not evaluate the input sequence until requested.
477477
/// </summary>
478478
///
479-
/// <param name="mapping">A function to transform items from the input task sequence that also access the current index.</param>
479+
/// <param name="mapper">A function to transform items from the input task sequence that also access the current index.</param>
480480
/// <param name="source">The input task sequence.</param>
481481
/// <returns>The resulting task sequence.</returns>
482482
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
483483
static member mapi: mapper: (int -> 'T -> 'U) -> source: TaskSeq<'T> -> TaskSeq<'U>
484484

485485
/// <summary>
486-
/// Builds a new task sequence whose elements are the results of applying the asynchronous <paramref name="action" />
486+
/// Builds a new task sequence whose elements are the results of applying the asynchronous <paramref name="mapper" />
487487
/// function to each of the elements of the input task sequence in <paramref name="source" />.
488488
/// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
489489
/// method on async enumerators retrieved from the input task sequence.
490490
/// Does not evaluate the input sequence until requested.
491491
/// </summary>
492492
///
493-
/// <param name="mapping">An asynchronous function to transform items from the input task sequence.</param>
493+
/// <param name="mapper">An asynchronous function to transform items from the input task sequence.</param>
494494
/// <param name="source">The input task sequence.</param>
495495
/// <returns>The resulting task sequence.</returns>
496496
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
497497
static member mapAsync: mapper: ('T -> #Task<'U>) -> source: TaskSeq<'T> -> TaskSeq<'U>
498498

499499
/// <summary>
500-
/// Builds a new task sequence whose elements are the results of applying the asynchronous <paramref name="action" />
500+
/// Builds a new task sequence whose elements are the results of applying the asynchronous <paramref name="mapper" />
501501
/// function to each of the elements of the input task sequence in <paramref name="source" />, passing
502-
/// an extra zero-based index argument to the <paramref name="action" /> function.
502+
/// an extra zero-based index argument to the <paramref name="mapper" /> function.
503503
/// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
504504
/// method on async enumerators retrieved from the input task sequence.
505505
/// Does not evaluate the input sequence until requested.
506506
/// </summary>
507507
///
508-
/// <param name="mapping">An asynchronous function to transform items from the input task sequence that also access the current index.</param>
508+
/// <param name="mapper">An asynchronous function to transform items from the input task sequence that also access the current index.</param>
509509
/// <param name="source">The input task sequence.</param>
510510
/// <returns>The resulting task sequence.</returns>
511511
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
@@ -640,6 +640,7 @@ type TaskSeq =
640640
/// </summary>
641641
///
642642
/// <param name="source">The input task sequence.</param>
643+
/// <param name="index">The index of the item to retrieve.</param>
643644
/// <returns>The nth element of the task sequence, or None if it doesn't exist.</returns>
644645
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
645646
static member tryItem: index: int -> source: TaskSeq<'T> -> Task<'T option>
@@ -651,6 +652,7 @@ type TaskSeq =
651652
/// </summary>
652653
///
653654
/// <param name="source">The input task sequence.</param>
655+
/// <param name="index">The index of the item to retrieve.</param>
654656
/// <returns>The nth element of the task sequence.</returns>
655657
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
656658
/// <exception cref="T:ArgumentException">Thrown when the sequence has insufficient length or <paramref name="index" /> is negative.</exception>
@@ -1163,8 +1165,8 @@ type TaskSeq =
11631165

11641166
/// <summary>
11651167
/// Applies the function <paramref name="folder" /> to each element in the task sequence, threading an accumulator
1166-
/// argument of type <typeref name="'State" /> through the computation. If the input function is <paramref name="f" /> and the elements are <paramref name="i0...iN" />
1167-
/// then computes <paramref name="f (... (f s i0)...) iN" />.
1168+
/// argument of type <typeref name="'State" /> through the computation. If the input function is <code>f</code> and the elements are <code>i0...iN</code>
1169+
/// then computes <code>f (... (f s i0)...) iN</code>.
11681170
/// If the accumulator function <paramref name="folder" /> is asynchronous, consider using <see cref="TaskSeq.foldAsync" />.
11691171
/// </summary>
11701172
///
@@ -1177,8 +1179,8 @@ type TaskSeq =
11771179

11781180
/// <summary>
11791181
/// Applies the asynchronous function <paramref name="folder" /> to each element in the task sequence, threading an accumulator
1180-
/// argument of type <typeref name="'State" /> through the computation. If the input function is <paramref name="f" /> and the elements are <paramref name="i0...iN" />
1181-
/// then computes <paramref name="f (... (f s i0)...) iN" />.
1182+
/// argument of type <typeref name="'State" /> through the computation. If the input function is <code>f</code> and the elements are <code>i0...iN</code>
1183+
/// then computes <code>f (... (f s i0)...) iN</code>.
11821184
/// If the accumulator function <paramref name="folder" /> is synchronous, consider using <see cref="TaskSeq.fold" />.
11831185
/// </summary>
11841186
///

src/FSharp.Control.TaskSeq/TaskSeqInternal.fs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ module internal TaskSeqInternal =
8686

8787
let empty<'T> =
8888
{ new IAsyncEnumerable<'T> with
89-
member _.GetAsyncEnumerator(_) =
89+
member _.GetAsyncEnumerator _ =
9090
{ new IAsyncEnumerator<'T> with
9191
member _.MoveNextAsync() = ValueTask.False
9292
member _.Current = Unchecked.defaultof<'T>
@@ -96,7 +96,7 @@ module internal TaskSeqInternal =
9696

9797
let singleton (value: 'T) =
9898
{ new IAsyncEnumerable<'T> with
99-
member _.GetAsyncEnumerator(_) =
99+
member _.GetAsyncEnumerator _ =
100100
let mutable status = BeforeAll
101101

102102
{ new IAsyncEnumerator<'T> with

0 commit comments

Comments
 (0)