Skip to content
Merged
Show file tree
Hide file tree
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
332 changes: 207 additions & 125 deletions README.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public static partial class FileSystemExtensions
/// Subscribes via <see cref="INotificationHandler.OnEventOrReplay" /> so notifications
/// that already fired on this <see cref="MockFileSystem" /> count toward the quantifier.
/// The assertion always waits up to a timeout for late-arriving (asynchronous)
/// notifications 30 seconds by default; use <c>.Within(timeout)</c> to override.
/// notifications (30 seconds by default; use <c>.Within(timeout)</c> to override).
/// </remarks>
public static TriggeredNotificationResult TriggeredNotification(
this IThat<MockFileSystem> subject)
Expand All @@ -34,7 +34,7 @@ public static TriggeredNotificationResult TriggeredNotification(
/// Subscribes via <see cref="INotificationHandler.OnEventOrReplay" /> so notifications
/// that already fired on this <see cref="MockFileSystem" /> count toward the quantifier.
/// The assertion always waits up to a timeout for late-arriving (asynchronous)
/// notifications 30 seconds by default; use <c>.Within(timeout)</c> to override.
/// notifications (30 seconds by default; use <c>.Within(timeout)</c> to override).
/// </remarks>
public static TriggeredNotificationResult TriggeredNotification(
this IThat<MockFileSystem> subject,
Expand All @@ -56,8 +56,8 @@ public static TriggeredNotificationResult TriggeredNotification(
/// <remarks>
/// Subscribes via <see cref="INotificationHandler.OnEventOrReplay" /> so any notification
/// that already fired on this <see cref="MockFileSystem" /> fails the assertion. The
/// assertion also waits up to a timeout for late-arriving notifications 30 seconds by
/// default; use <c>.Within(timeout)</c> to lower it when you do not need to wait. The
/// assertion also waits up to a timeout for late-arriving notifications (30 seconds by
/// default; use <c>.Within(timeout)</c> to lower it when you do not need to wait). The
/// assertion short-circuits as soon as a matching notification is observed.
/// </remarks>
public static DidNotTriggerNotificationResult DidNotTriggerNotification(
Expand Down
24 changes: 12 additions & 12 deletions Source/aweXpect.Testably/FileSystemWatcherExtensions.Triggered.cs
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ public static class FileSystemWatcherExtensions
/// <remarks>
/// Subscribes via <see cref="IWatcherTriggeredHandler.OnTriggeredOrReplay" />, so events
/// that already fired on this watcher count toward the quantifier. The assertion always
/// waits up to a timeout for late-arriving (asynchronous) events 30 seconds by default;
/// use <c>.Within(timeout)</c> to override.
/// The subject must be created from a <see cref="MockFileSystem" /> calling this on a
/// real-file-system watcher throws <see cref="InvalidOperationException" />. The watcher's
/// waits up to a timeout for late-arriving (asynchronous) events (30 seconds by default;
/// use <c>.Within(timeout)</c> to override).
/// The subject must be created from a <see cref="MockFileSystem" /> (calling this on a
/// real-file-system watcher throws <see cref="InvalidOperationException" />). The watcher's
/// <see cref="IFileSystemWatcher.EnableRaisingEvents" /> must be <see langword="true" /> for
/// any event to be observed.
/// </remarks>
Expand All @@ -41,10 +41,10 @@ public static TriggeredWatcherResult Triggered(
/// <remarks>
/// Subscribes via <see cref="IWatcherTriggeredHandler.OnTriggeredOrReplay" />, so events
/// that already fired on this watcher count toward the quantifier. The assertion always
/// waits up to a timeout for late-arriving (asynchronous) events 30 seconds by default;
/// use <c>.Within(timeout)</c> to override.
/// The subject must be created from a <see cref="MockFileSystem" /> calling this on a
/// real-file-system watcher throws <see cref="InvalidOperationException" />. The watcher's
/// waits up to a timeout for late-arriving (asynchronous) events (30 seconds by default;
/// use <c>.Within(timeout)</c> to override).
/// The subject must be created from a <see cref="MockFileSystem" /> (calling this on a
/// real-file-system watcher throws <see cref="InvalidOperationException" />). The watcher's
/// <see cref="IFileSystemWatcher.EnableRaisingEvents" /> must be <see langword="true" /> for
/// any event to be observed.
/// </remarks>
Expand All @@ -68,11 +68,11 @@ public static TriggeredWatcherResult Triggered(
/// <remarks>
/// Subscribes via <see cref="IWatcherTriggeredHandler.OnTriggeredOrReplay" /> so any event
/// that already fired on this watcher fails the assertion. The assertion also waits up to a
/// timeout for late-arriving events 30 seconds by default; use <c>.Within(timeout)</c>
/// to lower it when you do not need to wait. The assertion short-circuits as soon as a
/// timeout for late-arriving events (30 seconds by default; use <c>.Within(timeout)</c>
/// to lower it when you do not need to wait). The assertion short-circuits as soon as a
/// matching event is observed.
/// The subject must be created from a <see cref="MockFileSystem" /> calling this on a
/// real-file-system watcher throws <see cref="InvalidOperationException" />. The watcher's
/// The subject must be created from a <see cref="MockFileSystem" /> (calling this on a
/// real-file-system watcher throws <see cref="InvalidOperationException" />). The watcher's
/// <see cref="IFileSystemWatcher.EnableRaisingEvents" /> must be <see langword="true" /> for
/// any event to be observed.
/// </remarks>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ internal DidNotTriggerNotificationResult(
/// <remarks>
/// The <paramref name="expectation" /> is applied as an additional per-change filter, so any
/// assertions from <see cref="ChangeDescriptionExtensions" /> (e.g. <c>.HasName(...)</c>,
/// <c>.HasChangeType(...)</c>) compose naturally the assertion fails if any notification
/// satisfies all of them. The expectation text is taken from the inner expectation builder,
/// <c>.HasChangeType(...)</c>) compose naturally (the assertion fails if any notification
/// satisfies all of them). The expectation text is taken from the inner expectation builder,
/// so it reads like <c>matching has name equal to "foo.txt"</c> rather than the raw lambda
/// source.
/// </remarks>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ internal DidNotTriggerWatcherResult(
/// <remarks>
/// The <paramref name="expectation" /> is applied as an additional per-event filter, so any
/// assertions from <see cref="ChangeDescriptionExtensions" /> (e.g. <c>.HasName(...)</c>,
/// <c>.HasChangeType(...)</c>) compose naturally — the assertion fails if any event
/// <c>.HasChangeType(...)</c>) compose naturally. The assertion fails if any event
/// satisfies all of them. The expectation text is taken from the inner expectation builder,
/// so it reads like <c>which has name equal to "foo.txt"</c> rather than the raw lambda
/// source.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ internal TriggeredNotificationResult(
/// <remarks>
/// The <paramref name="expectation" /> is applied as an additional per-change filter, so any
/// assertions from <see cref="ChangeDescriptionExtensions" /> (e.g. <c>.HasName(...)</c>,
/// <c>.HasChangeType(...)</c>) compose naturally only notifications that satisfy all of
/// them count toward the quantifier. The expectation text is taken from the inner
/// <c>.HasChangeType(...)</c>) compose naturally (only notifications that satisfy all of
/// them count toward the quantifier). The expectation text is taken from the inner
/// expectation builder, so it reads like <c>matching has name equal to "foo.txt"</c> rather
/// than the raw lambda source.
/// </remarks>
Expand Down
4 changes: 2 additions & 2 deletions Source/aweXpect.Testably/Results/TriggeredWatcherResult.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ internal TriggeredWatcherResult(
/// <remarks>
/// The <paramref name="expectation" /> is applied as an additional per-event filter, so any
/// assertions from <see cref="ChangeDescriptionExtensions" /> (e.g. <c>.HasName(...)</c>,
/// <c>.HasChangeType(...)</c>) compose naturally only events that satisfy all of them
/// count toward the quantifier. The expectation text is taken from the inner expectation
/// <c>.HasChangeType(...)</c>) compose naturally (only events that satisfy all of them
/// count toward the quantifier). The expectation text is taken from the inner expectation
/// builder, so it reads like <c>which has name equal to "foo.txt"</c> rather than the raw
/// lambda source.
/// </remarks>
Expand Down
2 changes: 1 addition & 1 deletion Source/aweXpect.Testably/TimerExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public static class TimerExtensions
/// </summary>
/// <remarks>
/// Polls <see cref="ITimerMock.ExecutionCount" /> until either the quantifier is satisfied
/// or the timeout expires 30 seconds by default; use <c>.Within(timeout)</c> to override.
/// or the timeout expires (30 seconds by default; use <c>.Within(timeout)</c> to override).
/// </remarks>
public static TimerExecutedResult Executed(
this IThat<ITimerMock> subject)
Expand Down
Loading