Skip to content

Use <inheritdoc/> on base-class interface implementations #135

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
Chris-Wolfgang merged 1 commit into from
Apr 24, 2026
Merged

Use <inheritdoc/> on base-class interface implementations #135

Show file tree
Hide file tree
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
46 changes: 4 additions & 42 deletions src/Wolfgang.Etl.Abstractions/ExtractorBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,48 +164,23 @@ public int SkipItemCount



/// <summary>
/// Asynchronously extracts data of type TSource from a source.
/// </summary>
/// <returns>
/// IAsyncEnumerable&lt;TSource&gt;
/// The result may be an empty sequence if no data is available or if the extraction fails.
/// </returns>
/// <inheritdoc/>
public virtual IAsyncEnumerable<TSource> ExtractAsync()
{
return ExtractWorkerAsync(CancellationToken.None);
}



/// <summary>
/// Asynchronously extracts data of type TSource from a source.
/// </summary>
/// <param name="token">A CancellationToken to observe while waiting for the task to complete.</param>
/// <returns>
/// IAsyncEnumerable&lt;TSource&gt;
/// The result may be an empty sequence if no data is available or if the extraction fails.
/// </returns>
/// <remarks>
/// The extractor should be able to handle cancellation requests gracefully.
/// If the caller doesn't plan on cancelling the extraction, they can pass CancellationToken.None.
/// </remarks>
/// <inheritdoc/>
public virtual IAsyncEnumerable<TSource> ExtractAsync(CancellationToken token)
{
return ExtractWorkerAsync(token);
}



/// <summary>
/// Asynchronously extracts data of type TSource from a source.
/// </summary>
/// <param name="progress">A provider for progress updates.</param>
/// <returns>
/// IAsyncEnumerable&lt;TSource&gt;
/// The result may be an empty sequence if no data is available or if the extraction fails.
/// </returns>
/// <exception cref="ArgumentNullException">The value of progress is null</exception>
/// <inheritdoc/>
public virtual IAsyncEnumerable<TSource> ExtractAsync(IProgress<TProgress> progress)
{
#if NET6_0_OR_GREATER
Expand All @@ -224,20 +199,7 @@ public virtual IAsyncEnumerable<TSource> ExtractAsync(IProgress<TProgress> progr



/// <summary>
/// Asynchronously extracts data of type TSource from a source.
/// </summary>
/// <param name="progress">A provider for progress updates.</param>
/// <param name="token">A CancellationToken to observe while waiting for the task to complete.</param>
/// <returns>
/// IAsyncEnumerable&lt;TSource&gt;
/// The result may be an empty sequence if no data is available or if the extraction fails.
/// </returns>
/// <remarks>
/// The extractor should be able to handle cancellation requests gracefully.
/// If the caller doesn't plan on cancelling the extraction, they can pass CancellationToken.None.
/// </remarks>
/// <exception cref="ArgumentNullException">The value of progress is null</exception>
/// <inheritdoc/>
public virtual IAsyncEnumerable<TSource> ExtractAsync(IProgress<TProgress> progress, CancellationToken token)
{
#if NET6_0_OR_GREATER
Expand Down
46 changes: 4 additions & 42 deletions src/Wolfgang.Etl.Abstractions/LoaderBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,15 +137,7 @@ public int SkipItemCount



/// <summary>
/// Asynchronously loads data of type TDestination into the target destination.
/// </summary>
/// <param name="items">The items to be loaded to the destination.</param>
/// <returns>A task representing the asynchronous operation.</returns>
/// <remarks>
/// Items may be an empty sequence if no data is available or if the loading fails.
/// </remarks>
/// <exception cref="ArgumentNullException">Argument items is null</exception>
/// <inheritdoc/>
public virtual Task LoadAsync(IAsyncEnumerable<TDestination> items)
{
#if NET6_0_OR_GREATER
Expand All @@ -163,16 +155,7 @@ public virtual Task LoadAsync(IAsyncEnumerable<TDestination> items)



/// <summary>
/// Asynchronously loads data of type TDestination into the target destination.
/// </summary>
/// <param name="items">The items to be loaded to the destination.</param>
/// <param name="token">A CancellationToken to observe while waiting for the task to complete.</param>
/// <returns>A task representing the asynchronous operation.</returns>
/// <remarks>
/// Items may be an empty sequence if no data is available or if the loading fails.
/// </remarks>
/// <exception cref="ArgumentNullException">Argument items is null</exception>
/// <inheritdoc/>
public virtual Task LoadAsync(IAsyncEnumerable<TDestination> items, CancellationToken token)
{
#if NET6_0_OR_GREATER
Expand All @@ -190,17 +173,7 @@ public virtual Task LoadAsync(IAsyncEnumerable<TDestination> items, Cancellation



/// <summary>
/// Asynchronously loads data of type TDestination into the target destination.
/// </summary>
/// <param name="items">The items to be loaded to the destination.</param>
/// <param name="progress">A provider for progress updates.</param>
/// <returns>A task representing the asynchronous operation.</returns>
/// <remarks>
/// Items may be an empty sequence if no data is available or if the loading fails.
/// </remarks>
/// <exception cref="ArgumentNullException">Argument items is null</exception>
/// <exception cref="ArgumentNullException">Argument progress is null</exception>
/// <inheritdoc/>
public virtual Task LoadAsync(IAsyncEnumerable<TDestination> items, IProgress<TProgress> progress)
{
#if NET6_0_OR_GREATER
Expand All @@ -224,18 +197,7 @@ public virtual Task LoadAsync(IAsyncEnumerable<TDestination> items, IProgress<TP



/// <summary>
/// Asynchronously loads data of type TDestination into the target destination.
/// </summary>
/// <param name="items">The items to be loaded to the destination.</param>
/// <param name="progress">A provider for progress updates.</param>
/// <param name="token">A CancellationToken to observe while waiting for the task to complete.</param>
/// <returns>A task representing the asynchronous operation.</returns>
/// <remarks>
/// Items may be an empty sequence if no data is available or if the loading fails.
/// </remarks>
/// <exception cref="ArgumentNullException">Argument items is null</exception>
/// <exception cref="ArgumentNullException">Argument progress is null</exception>
/// <inheritdoc/>
public virtual Task LoadAsync(IAsyncEnumerable<TDestination> items, IProgress<TProgress> progress, CancellationToken token)
{
#if NET6_0_OR_GREATER
Expand Down
51 changes: 4 additions & 47 deletions src/Wolfgang.Etl.Abstractions/TransformerBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,15 +140,7 @@ public int SkipItemCount



/// <summary>
/// Asynchronously transforms data of type TSource to TDestination
/// </summary>
/// <param name="items">IAsyncEnumerable&lt;TSource&gt; - A list of 0 or more items to be transformed</param>
/// <returns>
/// IAsyncEnumerable&lt;TDestination&gt;
/// The result may be an empty sequence if no data is available or if the transformation fails.
/// </returns>
/// <exception cref="ArgumentNullException">The value of items is null</exception>
/// <inheritdoc/>
public virtual IAsyncEnumerable<TDestination> TransformAsync(IAsyncEnumerable<TSource> items)
{
#if NET6_0_OR_GREATER
Expand All @@ -166,19 +158,7 @@ public virtual IAsyncEnumerable<TDestination> TransformAsync(IAsyncEnumerable<TS



/// <summary>
/// Asynchronously transforms data of type TSource to TDestination
/// </summary>
/// <param name="items">IAsyncEnumerable&lt;TSource&gt; - A list of 0 or more items to be transformed</param>
/// <param name="token">A CancellationToken to observe while waiting for the task to complete.</param>
/// <returns>
/// IAsyncEnumerable&lt;TDestination&gt; - A list of 0 or more transformed items
/// </returns>
/// <remarks>
/// The transformer should be able to handle cancellation requests gracefully.
/// If the caller doesn't plan on cancelling the transformation, they can pass CancellationToken.None.
/// </remarks>
/// <exception cref="ArgumentNullException">The value of items is null</exception>
/// <inheritdoc/>
public virtual IAsyncEnumerable<TDestination> TransformAsync(IAsyncEnumerable<TSource> items, CancellationToken token)
{
#if NET6_0_OR_GREATER
Expand All @@ -196,16 +176,7 @@ public virtual IAsyncEnumerable<TDestination> TransformAsync(IAsyncEnumerable<TS



/// <summary>
/// Asynchronously transforms data of type TSource to TDestination
/// </summary>
/// <param name="items">IAsyncEnumerable&lt;TSource&gt; - A list of 0 or more items to be transformed</param>
/// <param name="progress">A provider for progress updates.</param>
/// <returns>
/// IAsyncEnumerable&lt;TDestination&gt; - The result may be an empty sequence if no data is available or if the transformation fails.
/// </returns>
/// <exception cref="ArgumentNullException">The value of items is null</exception>
/// <exception cref="ArgumentNullException">The value of progress is null</exception>
/// <inheritdoc/>
public virtual IAsyncEnumerable<TDestination> TransformAsync(IAsyncEnumerable<TSource> items, IProgress<TProgress> progress)
{
#if NET6_0_OR_GREATER
Expand All @@ -229,21 +200,7 @@ public virtual IAsyncEnumerable<TDestination> TransformAsync(IAsyncEnumerable<TS



/// <summary>
/// Asynchronously transforms data of type TSource to TDestination
/// </summary>
/// <param name="items">IAsyncEnumerable&lt;TSource&gt; - A list of 0 or more items to be transformed</param>
/// <param name="progress">A provider for progress updates.</param>
/// <param name="token">A CancellationToken to observe while waiting for the task to complete.</param>
/// <returns>
/// IAsyncEnumerable&lt;TDestination&gt; - The result may be an empty sequence if no data is available or if the transformation fails.
/// </returns>
/// <remarks>
/// The transformer should be able to handle cancellation requests gracefully.
/// If the caller doesn't plan on cancelling the transformation, they can pass CancellationToken.None.
/// </remarks>
/// <exception cref="ArgumentNullException">The value of items is null</exception>
/// <exception cref="ArgumentNullException">The value of progress is null</exception>
/// <inheritdoc/>
public virtual IAsyncEnumerable<TDestination> TransformAsync(IAsyncEnumerable<TSource> items, IProgress<TProgress> progress, CancellationToken token)
{
#if NET6_0_OR_GREATER
Expand Down
Loading