Skip to content

Commit

Permalink
Add missing remarks tags on "Batch" overload (#849)
Browse files Browse the repository at this point in the history
  • Loading branch information
atifaziz authored Oct 20, 2022
1 parent 57e1d78 commit a573c06
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions MoreLinq/Batch.cs
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ public static IEnumerable<IEnumerable<TSource>> Batch<TSource>(this IEnumerable<
/// <param name="size">Size of buckets.</param>
/// <param name="resultSelector">The projection to apply to each bucket.</param>
/// <returns>A sequence of projections on equally sized buckets containing elements of the source collection.</returns>
/// <remarks>
/// <para>
/// This operator uses deferred execution and streams its results
/// (buckets are streamed but their content buffered).</para>
Expand All @@ -77,6 +78,7 @@ public static IEnumerable<IEnumerable<TSource>> Batch<TSource>(this IEnumerable<
/// hoping for a single bucket, then it can lead to memory exhaustion
/// (<see cref="OutOfMemoryException"/>).
/// </para>
/// </remarks>

public static IEnumerable<TResult> Batch<TSource, TResult>(this IEnumerable<TSource> source, int size,
Func<IEnumerable<TSource>, TResult> resultSelector)
Expand Down
2 changes: 2 additions & 0 deletions MoreLinq/Extensions.g.cs
Original file line number Diff line number Diff line change
Expand Up @@ -690,6 +690,7 @@ public static IEnumerable<IEnumerable<TSource>> Batch<TSource>(this IEnumerable<
/// <param name="size">Size of buckets.</param>
/// <param name="resultSelector">The projection to apply to each bucket.</param>
/// <returns>A sequence of projections on equally sized buckets containing elements of the source collection.</returns>
/// <remarks>
/// <para>
/// This operator uses deferred execution and streams its results
/// (buckets are streamed but their content buffered).</para>
Expand All @@ -705,6 +706,7 @@ public static IEnumerable<IEnumerable<TSource>> Batch<TSource>(this IEnumerable<
/// hoping for a single bucket, then it can lead to memory exhaustion
/// (<see cref="OutOfMemoryException"/>).
/// </para>
/// </remarks>

public static IEnumerable<TResult> Batch<TSource, TResult>(this IEnumerable<TSource> source, int size,
Func<IEnumerable<TSource>, TResult> resultSelector)
Expand Down

0 comments on commit a573c06

Please sign in to comment.