Skip to content
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.

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

Update Memoize documentation #895

Merged
merged 1 commit into from
Nov 19, 2022
Merged
Changes from all commits
Commits
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
16 changes: 10 additions & 6 deletions MoreLinq/Experimental/Memoize.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,21 @@ static partial class ExperimentalEnumerable
/// Type of elements in <paramref name="source"/>.</typeparam>
/// <param name="source">The source sequence.</param>
/// <returns>
/// Returns a sequence that corresponds to a cached version of the
/// input sequence.</returns>
/// Returns a sequence that corresponds to a cached version of the input
/// sequence.
/// </returns>
/// <exception cref="ArgumentNullException">
/// <paramref name="source"/> is <see langword="null"/>.
/// </exception>
/// <remarks>
/// The returned <see cref="IEnumerable{T}"/> will cache items from
/// <paramref name="source"/> in a thread-safe manner. Each thread can
/// call its <see cref="IEnumerable{T}.GetEnumerator"/> to acquire an
/// iterator but the same iterator should not be used simultanesouly
/// from multiple threads. The sequence supplied in
/// <paramref name="source"/> is not expected to be thread-safe but it
/// is required to be thread-agnostic because different threads
/// (though never simultaneously) may iterate over the sequence.
/// from multiple threads. The sequence supplied in <paramref
/// name="source"/> is not expected to be thread-safe but it is required
/// to be thread-agnostic because different threads (though never
/// simultaneously) may iterate over the sequence.
/// </remarks>

public static IEnumerable<T> Memoize<T>(this IEnumerable<T> source)
Expand Down