Skip to content
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.

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

Explain semantics of multiple calls to CancellationTokenSource.Cancel #11105

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Smaug123
Copy link
Contributor

Also copy a line about LIFO semantics from one of the overloads, to unify the docs for each function.

Summary

Earlier today, I needed to perform several experiments to discover the semantics of CancellationTokenSource.Cancel, because they are undocumented.

I don't know the semantics of CancelAsync, so I haven't documented them.

Also copy a line about LIFO semantics from one of the overloads,
to unify the docs for each function.
@github-actions github-actions bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Mar 18, 2025
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Mar 18, 2025
@Smaug123 Smaug123 marked this pull request as ready for review March 18, 2025 20:09
@Smaug123 Smaug123 requested a review from kouvel as a code owner March 18, 2025 20:09
Copy link

Learn Build status updates of commit 5a2b566:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Threading/CancellationTokenSource.xml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@gewarren gewarren added area-System.Threading and removed needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners labels Mar 25, 2025
Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left some grammatical suggestions. Thanks!

@Smaug123
Copy link
Contributor Author

Some scope creep, but I've gone over every use of the word "will" in the file and replaced it with a present tense unless it's describing asynchrony or future actions.

Copy link

Learn Build status updates of commit 8094c7a:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Threading/CancellationTokenSource.xml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-System.Threading community-contribution Indicates that the PR has been added by a community member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants