Skip to content

Commit d18720c

Browse files
authored
Fix misleading XML documentation for pairwise functions (#18587)
1 parent cad478b commit d18720c

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

src/FSharp.Core/array.fsi

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1919,8 +1919,9 @@ module Array =
19191919
[<CompiledName("OfSeq")>]
19201920
val ofSeq: source: seq<'T> -> 'T array
19211921

1922-
/// <summary>Returns an array of each element in the input array and its predecessor, with the
1923-
/// exception of the first element which is only returned as the predecessor of the second element.</summary>
1922+
/// <summary>Returns an array of each element in the input array paired with its predecessor, with the
1923+
/// exception of the first element which is only returned as the predecessor of the second element.
1924+
/// The predecessor comes first in the returned pairs.</summary>
19241925
///
19251926
/// <param name="array">The input array.</param>
19261927
///

src/FSharp.Core/list.fsi

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1613,8 +1613,9 @@ module List =
16131613
[<CompiledName("OfSeq")>]
16141614
val ofSeq: source:seq<'T> -> 'T list
16151615

1616-
/// <summary>Returns a list of each element in the input list and its predecessor, with the
1617-
/// exception of the first element which is only returned as the predecessor of the second element.</summary>
1616+
/// <summary>Returns a list of each element in the input list paired with its predecessor, with the
1617+
/// exception of the first element which is only returned as the predecessor of the second element.
1618+
/// The predecessor comes first in the returned pairs.</summary>
16181619
///
16191620
/// <param name="list">The input list.</param>
16201621
///

src/FSharp.Core/seq.fsi

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1852,8 +1852,9 @@ module Seq =
18521852
[<CompiledName("OfList")>]
18531853
val ofList: source: 'T list -> seq<'T>
18541854

1855-
/// <summary>Returns a sequence of each element in the input sequence and its predecessor, with the
1856-
/// exception of the first element which is only returned as the predecessor of the second element.</summary>
1855+
/// <summary>Returns a sequence of each element in the input sequence paired with its predecessor, with the
1856+
/// exception of the first element which is only returned as the predecessor of the second element.
1857+
/// The predecessor comes first in the returned pairs.</summary>
18571858
///
18581859
/// <param name="source">The input sequence.</param>
18591860
///

0 commit comments

Comments
 (0)