Skip to content

Fix misleading Seq.init XML doc #19293

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

Open
bbatsov wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −4
Open

Fix misleading Seq.init XML doc #19293

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions src/FSharp.Core/seq.fsi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1325,12 +1325,13 @@ module Seq =
val indexed: source: seq<'T> -> seq<int * 'T>

/// <summary>Generates a new sequence which, when iterated, will return successive
/// elements by calling the given function, up to the given count. Each element is saved after its
/// initialization. The function is passed the index of the item being
/// generated.</summary>
/// elements by calling the given function, up to the given count. The results of calling the function
/// will not be saved, that is the function will be reapplied as necessary to
/// regenerate the elements. The function is passed the index of the item being
/// generated. To cache the results, see <see cref="M:Microsoft.FSharp.Collections.SeqModule.Cache``1"/>.</summary>
///
/// <remarks>The returned sequence may be passed between threads safely. However,
/// individual IEnumerator values generated from the returned sequence should not be accessed concurrently. This is an O(n) operation, where n is the count.</remarks>
/// individual IEnumerator values generated from the returned sequence should not be accessed concurrently.</remarks>
Copy link
Member

@T-Gro T-Gro Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please keep the complexity docs. In case of seq, those can be also split into construction complexity and enumeration complexity (expressed in terms of function invocations in this case)

///
/// <param name="count">The maximum number of items to generate for the sequence.</param>
/// <param name="initializer">A function that generates an item in the sequence from a given index.</param>
Expand Down
Loading