Skip to content

[UUF] Add missing word #11694

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
merged 1 commit into from
Aug 18, 2025
Merged

[UUF] Add missing word #11694

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
3 changes: 2 additions & 1 deletion xml/System.Threading/PeriodicTimer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ This timer is intended to be used only by a single consumer at a time: only one
<Docs>
<summary>Gets or sets the period between ticks.</summary>
<value>To be added.</value>
<remarks>All prior ticks of the timer, including any that may be waiting to be consumed by <see cref="M:System.Threading.PeriodicTimer.WaitForNextTickAsync(System.Threading.CancellationToken)" />, are unaffected by changes to <see cref="P:System.Threading.PeriodicTimer.Period" />. Setting <see cref="P:System.Threading.PeriodicTimer.Period" /> affects only and all subsequent times at which the timer will tick.</remarks>
<remarks>All prior ticks of the timer, including any that might be waiting to be consumed by <see cref="M:System.Threading.PeriodicTimer.WaitForNextTickAsync(System.Threading.CancellationToken)" />, are unaffected by changes to <see cref="P:System.Threading.PeriodicTimer.Period" />. Setting <see cref="P:System.Threading.PeriodicTimer.Period" /> affects only the current period and all subsequent times at which the timer will tick.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="value" /> must be <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" /> or represent a number of milliseconds equal to or larger than 1 and smaller than <see cref="F:System.UInt32.MaxValue" />.</exception>
</Docs>
Expand Down Expand Up @@ -209,6 +209,7 @@ This timer is intended to be used only by a single consumer at a time: only one

The <xref:System.Threading.PeriodicTimer> behaves like an auto-reset event, in that multiple ticks are coalesced into a single tick if they occur between calls to <xref:System.Threading.PeriodicTimer.WaitForNextTickAsync(System.Threading.CancellationToken)>. Similarly, a call to <xref:System.Threading.PeriodicTimer.Dispose> will void any tick not yet consumed. <xref:System.Threading.PeriodicTimer.WaitForNextTickAsync(System.Threading.CancellationToken)> may only be used by one consumer at a time, and may be used concurrently with a single call to <xref:System.Threading.PeriodicTimer.Dispose>.


]]></format>
</remarks>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
Expand Down