Skip to content

Commit 54182c4

Browse files
authored
Fix comments on CancellationTokenRegistration.Token (#4186)
1 parent 65eca8c commit 54182c4

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

xml/System.Threading/CancellationTokenRegistration.xml

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -450,12 +450,17 @@ The returned <xref:System.Threading.Tasks.ValueTask> completes once the associat
450450
<ReturnType>System.Threading.CancellationToken</ReturnType>
451451
</ReturnValue>
452452
<Docs>
453-
<summary>Gets the <see cref="T:System.Threading.CancellationToken" /> with which this registration is associated. If the
454-
registration isn't associated with a token (such as after the registration has been disposed),
455-
this will return a default token.</summary>
453+
<summary>Gets the <see cref="T:System.Threading.CancellationToken" /> with which this registration is associated.</summary>
456454
<value>The cancellation token with which this registration is associated, or a default token if the
457-
registration isn't associated with a token (such as after the registration has been disposed).</value>
458-
<remarks>To be added.</remarks>
455+
registration isn't associated with a token.</value>
456+
<remarks>
457+
<format type="text/markdown"><![CDATA[
458+
459+
If the <xref:System.Threading.CancellationTokenRegistration> was created by registering with a <xref:System.Threading.CancellationToken> that already
460+
had cancellation requested, the registration may not be associated with the token, in which case this property may return a default token.
461+
462+
]]></format>
463+
</remarks>
459464
</Docs>
460465
</Member>
461466
<Member MemberName="Unregister">

0 commit comments

Comments
 (0)