Skip to content

Fix misleading XML documentation for pairwise functions #18587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 26, 2025
Merged

Fix misleading XML documentation for pairwise functions #18587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0810473
Initial plan for issue
Copilot May 21, 2025
e5c0b2d
Fix pairwise XML documentation in List, Array, and Seq modules
Copilot May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/FSharp.Core/array.fsi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1919,8 +1919,9 @@ module Array =
[<CompiledName("OfSeq")>]
val ofSeq: source: seq<'T> -> 'T array

/// <summary>Returns an array of each element in the input array and its predecessor, with the
/// exception of the first element which is only returned as the predecessor of the second element.</summary>
/// <summary>Returns an array of each element in the input array paired with its predecessor, with the
/// exception of the first element which is only returned as the predecessor of the second element.
/// The predecessor comes first in the returned pairs.</summary>
///
/// <param name="array">The input array.</param>
///
Expand Down
5 changes: 3 additions & 2 deletions src/FSharp.Core/list.fsi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1613,8 +1613,9 @@ module List =
[<CompiledName("OfSeq")>]
val ofSeq: source:seq<'T> -> 'T list

/// <summary>Returns a list of each element in the input list and its predecessor, with the
/// exception of the first element which is only returned as the predecessor of the second element.</summary>
/// <summary>Returns a list of each element in the input list paired with its predecessor, with the
/// exception of the first element which is only returned as the predecessor of the second element.
/// The predecessor comes first in the returned pairs.</summary>
///
/// <param name="list">The input list.</param>
///
Expand Down
5 changes: 3 additions & 2 deletions src/FSharp.Core/seq.fsi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1852,8 +1852,9 @@ module Seq =
[<CompiledName("OfList")>]
val ofList: source: 'T list -> seq<'T>

/// <summary>Returns a sequence of each element in the input sequence and its predecessor, with the
/// exception of the first element which is only returned as the predecessor of the second element.</summary>
/// <summary>Returns a sequence of each element in the input sequence paired with its predecessor, with the
/// exception of the first element which is only returned as the predecessor of the second element.
/// The predecessor comes first in the returned pairs.</summary>
///
/// <param name="source">The input sequence.</param>
///
Expand Down
Loading