Skip to content

Commit

Permalink
Fix to code doc
Browse files Browse the repository at this point in the history
  • Loading branch information
egil committed May 8, 2020
1 parent 833e67d commit e8bde9b
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions src/bunit.core/Extensions/WaitForHelpers/WaitForHelper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,8 @@ public abstract class WaitForHelper : IDisposable
protected abstract bool StopWaitingOnCheckException { get; }

/// <summary>
/// Gets the task that will complete successfully if the assertion passed before the timeout was reached.
/// The task will complete with an <see cref="WaitForAssertionFailedException"/> exception if the timeout was reached without the assertion passing,
/// and will have the assertion exception as its InnerException.
/// Gets the task that will complete successfully if the check passed before the timeout was reached.
/// The task will complete with an <see cref="WaitForFailedException"/> exception if the timeout was reached without the check passing.
/// </summary>
public Task WaitTask => _completionSouce.Task;

Expand Down

0 comments on commit e8bde9b

Please sign in to comment.