Skip to content

Make the PeriodicTimer.WaitForNextTickAsync description more descriptive #119637

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+1 −1
Open

Make the PeriodicTimer.WaitForNextTickAsync description more descriptive #119637

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f43a8d6
Make the PeriodicTimer.WaitForNextTickAsync description more descriptive
Smaug123 Sep 12, 2025
9386b6f
Merge branch 'main' into improve-periodictimer-description
Smaug123 Sep 20, 2025
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
2 changes: 1 addition & 1 deletion src/libraries/System.Private.CoreLib/src/System/Threading/PeriodicTimer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ private static bool TryGetMilliseconds(TimeSpan value, out uint milliseconds)
/// A <see cref="CancellationToken"/> to use to cancel the asynchronous wait. If cancellation is requested, it affects only the single wait operation;
/// the underlying timer continues firing.
/// </param>
/// <returns>A task that will be completed due to the timer firing, <see cref="Dispose"/> being called to stop the timer, or cancellation being requested.</returns>
/// <returns>A <see cref="ValueTask" /> that will be completed due to the timer firing (in which case the result is <c>true</c>), <see cref="Dispose"/> being called to stop the timer (in which case the result is <c>false</c>), or cancellation being requested (in which case the task enters the Canceled state).</returns>
/// <remarks>
/// The <see cref="PeriodicTimer"/> behaves like an auto-reset event, in that multiple ticks are coalesced into a single tick if they occur between
/// calls to <see cref="WaitForNextTickAsync"/>. Similarly, a call to <see cref="Dispose"/> will void any tick not yet consumed. <see cref="WaitForNextTickAsync"/>
Expand Down
Loading