Skip to content

Commit c6c740f

Browse files
bartelinkabelbraaksma
authored andcommitted
Fix typos, spelling errors, misnamed paramref in xml docs
1 parent 75cbccc commit c6c740f

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
@@ -320,15 +320,15 @@ type TaskSeq private () =
320320

321321
static member exists predicate source =
322322
Internal.tryFind (Predicate predicate) source
323-
|> Task.map (Option.isSome)
323+
|> Task.map Option.isSome
324324

325325
static member existsAsync predicate source =
326326
Internal.tryFind (PredicateAsync predicate) source
327-
|> Task.map (Option.isSome)
327+
|> Task.map Option.isSome
328328

329329
static member contains value source =
330330
Internal.tryFind (Predicate((=) value)) source
331-
|> Task.map (Option.isSome)
331+
|> Task.map Option.isSome
332332

333333
static member pick chooser source =
334334
Internal.tryPick (TryPick chooser) source
@@ -354,8 +354,6 @@ type TaskSeq private () =
354354
Internal.tryFindIndex (PredicateAsync predicate) source
355355
|> Task.map (Option.defaultWith Internal.raiseNotFound)
356356

357-
358-
359357
//
360358
// zip/unzip/fold etc functions
361359
//

src/FSharp.Control.TaskSeq/TaskSeq.fsi

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

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

532532
/// <summary>
533-
/// Builds a new task sequence whose elements are the results of applying the <paramref name="action" />
533+
/// Builds a new task sequence whose elements are the results of applying the <paramref name="mapper" />
534534
/// function to each of the elements of the input task sequence in <paramref name="source" />.
535535
/// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
536536
/// method on async enumerators retrieved from the input task sequence.
537537
/// Does not evaluate the input sequence until requested.
538538
/// </summary>
539539
///
540-
/// <param name="mapping">A function to transform items from the input task sequence.</param>
540+
/// <param name="mapper">A function to transform items from the input task sequence.</param>
541541
/// <param name="source">The input task sequence.</param>
542542
/// <returns>The resulting task sequence.</returns>
543543
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
544544
static member map: mapper: ('T -> 'U) -> source: TaskSeq<'T> -> TaskSeq<'U>
545545

546546
/// <summary>
547-
/// Builds a new task sequence whose elements are the results of applying the <paramref name="action" />
547+
/// Builds a new task sequence whose elements are the results of applying the <paramref name="mapper" />
548548
/// function to each of the elements of the input task sequence in <paramref name="source" />, passing
549-
/// an extra zero-based index argument to the <paramref name="action" /> function.
549+
/// an extra zero-based index argument to the <paramref name="mapper" /> function.
550550
/// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
551551
/// method on async enumerators retrieved from the input task sequence.
552552
/// Does not evaluate the input sequence until requested.
553553
/// </summary>
554554
///
555-
/// <param name="mapping">A function to transform items from the input task sequence that also access the current index.</param>
555+
/// <param name="mapper">A function to transform items from the input task sequence that also access the current index.</param>
556556
/// <param name="source">The input task sequence.</param>
557557
/// <returns>The resulting task sequence.</returns>
558558
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
559559
static member mapi: mapper: (int -> 'T -> 'U) -> source: TaskSeq<'T> -> TaskSeq<'U>
560560

561561
/// <summary>
562-
/// Builds a new task sequence whose elements are the results of applying the asynchronous <paramref name="action" />
562+
/// Builds a new task sequence whose elements are the results of applying the asynchronous <paramref name="mapper" />
563563
/// function to each of the elements of the input task sequence in <paramref name="source" />.
564564
/// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
565565
/// method on async enumerators retrieved from the input task sequence.
566566
/// Does not evaluate the input sequence until requested.
567567
/// </summary>
568568
///
569-
/// <param name="mapping">An asynchronous function to transform items from the input task sequence.</param>
569+
/// <param name="mapper">An asynchronous function to transform items from the input task sequence.</param>
570570
/// <param name="source">The input task sequence.</param>
571571
/// <returns>The resulting task sequence.</returns>
572572
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
573573
static member mapAsync: mapper: ('T -> #Task<'U>) -> source: TaskSeq<'T> -> TaskSeq<'U>
574574

575575
/// <summary>
576-
/// Builds a new task sequence whose elements are the results of applying the asynchronous <paramref name="action" />
576+
/// Builds a new task sequence whose elements are the results of applying the asynchronous <paramref name="mapper" />
577577
/// function to each of the elements of the input task sequence in <paramref name="source" />, passing
578-
/// an extra zero-based index argument to the <paramref name="action" /> function.
578+
/// an extra zero-based index argument to the <paramref name="mapper" /> function.
579579
/// The given function will be applied as elements are pulled using the <see cref="MoveNextAsync" />
580580
/// method on async enumerators retrieved from the input task sequence.
581581
/// Does not evaluate the input sequence until requested.
582582
/// </summary>
583583
///
584-
/// <param name="mapping">An asynchronous function to transform items from the input task sequence that also access the current index.</param>
584+
/// <param name="mapper">An asynchronous function to transform items from the input task sequence that also access the current index.</param>
585585
/// <param name="source">The input task sequence.</param>
586586
/// <returns>The resulting task sequence.</returns>
587587
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
@@ -716,6 +716,7 @@ type TaskSeq =
716716
/// </summary>
717717
///
718718
/// <param name="source">The input task sequence.</param>
719+
/// <param name="index">The index of the item to retrieve.</param>
719720
/// <returns>The nth element of the task sequence, or None if it doesn't exist.</returns>
720721
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
721722
static member tryItem: index: int -> source: TaskSeq<'T> -> Task<'T option>
@@ -727,6 +728,7 @@ type TaskSeq =
727728
/// </summary>
728729
///
729730
/// <param name="source">The input task sequence.</param>
731+
/// <param name="index">The index of the item to retrieve.</param>
730732
/// <returns>The nth element of the task sequence.</returns>
731733
/// <exception cref="T:ArgumentNullException">Thrown when the input task sequence is null.</exception>
732734
/// <exception cref="T:ArgumentException">Thrown when the sequence has insufficient length or <paramref name="index" /> is negative.</exception>
@@ -1239,8 +1241,8 @@ type TaskSeq =
12391241

12401242
/// <summary>
12411243
/// Applies the function <paramref name="folder" /> to each element in the task sequence, threading an accumulator
1242-
/// 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" />
1243-
/// then computes <paramref name="f (... (f s i0)...) iN" />.
1244+
/// 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>
1245+
/// then computes <code>f (... (f s i0)...) iN</code>.
12441246
/// If the accumulator function <paramref name="folder" /> is asynchronous, consider using <see cref="TaskSeq.foldAsync" />.
12451247
/// </summary>
12461248
///
@@ -1253,8 +1255,8 @@ type TaskSeq =
12531255

12541256
/// <summary>
12551257
/// Applies the asynchronous function <paramref name="folder" /> to each element in the task sequence, threading an accumulator
1256-
/// 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" />
1257-
/// then computes <paramref name="f (... (f s i0)...) iN" />.
1258+
/// 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>
1259+
/// then computes <code>f (... (f s i0)...) iN</code>.
12581260
/// If the accumulator function <paramref name="folder" /> is synchronous, consider using <see cref="TaskSeq.fold" />.
12591261
/// </summary>
12601262
///

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)