Skip to content

Clarify scope of cancellation in Task.Run #4253

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 7 commits into from
Aug 4, 2020
Merged

Clarify scope of cancellation in Task.Run #4253

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
78845de
Clarify scope of cancelation in Task.Run
breyed May 17, 2020
ddb7586
Update xml/System.Threading.Tasks/Task.xml
breyed Jun 10, 2020
066fe96
Update xml/System.Threading.Tasks/Task.xml
breyed Jun 10, 2020
4e62702
Update xml/System.Threading.Tasks/Task.xml
breyed Jun 10, 2020
8244d16
Update xml/System.Threading.Tasks/Task.xml
breyed Jun 10, 2020
97ea62f
Apply suggestions from code review
gewarren Jun 22, 2020
a412ea4
Fix build warnings for crefs.
gewarren Jul 21, 2020
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
18 changes: 9 additions & 9 deletions xml/System.Threading.Tasks/Task.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3425,8 +3425,8 @@ Task t Status: RanToCompletion, Result: 42
</Parameters>
<Docs>
<param name="action">The work to execute asynchronously</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the work</param>
<summary>Queues the specified work to run on the thread pool and returns a <see cref="T:System.Threading.Tasks.Task" /> object that represents that work. A cancellation token allows the work to be cancelled.</summary>
<param name="cancellationToken">A cancellation token that can be used to cancel the work if it has not yet started. <see cref="Run"/> does not pass <paramref="cancellationToken"/> to <paramref="action"/>.</param>
<summary>Queues the specified work to run on the thread pool and returns a <see cref="T:System.Threading.Tasks.Task" /> object that represents that work. A cancellation token allows the work to be cancelled if it has not yet started.</summary>
<returns>A task that represents the work queued to execute in the thread pool.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down Expand Up @@ -3497,8 +3497,8 @@ Task t Status: RanToCompletion, Result: 42
</Parameters>
<Docs>
<param name="function">The work to execute asynchronously.</param>
<param name="cancellationToken">A cancellation token that should be used to cancel the work.</param>
<summary>Queues the specified work to run on the thread pool and returns a proxy for the task returned by <paramref name="function" />.</summary>
<param name="cancellationToken">A cancellation token that can be used to cancel the work if it has not yet started. <see cref="Run"/> does not pass <paramref="cancellationToken"/> to <paramref="action"/>.</param>
<summary>Queues the specified work to run on the thread pool and returns a proxy for the task returned by <paramref name="function" />. A cancellation token allows the work to be cancelled if it has not yet started.</summary>
<returns>A task that represents a proxy for the task returned by <paramref name="function" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down Expand Up @@ -3557,7 +3557,7 @@ Task t Status: RanToCompletion, Result: 42
<Docs>
<typeparam name="TResult">The type of the result returned by the proxy task.</typeparam>
<param name="function">The work to execute asynchronously</param>
<summary>Queues the specified work to run on the thread pool and returns a proxy for the <see langword="Task(TResult)" /> returned by <paramref name="function" />.</summary>
<summary>Queues the specified work to run on the thread pool and returns a proxy for the <see langword="Task(TResult)" /> returned by <paramref name="function" />. A cancellation token allows the work to be cancelled if it has not yet started.</summary>
<returns>A <see langword="Task(TResult)" /> that represents a proxy for the <see langword="Task(TResult)" /> returned by <paramref name="function" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down Expand Up @@ -3613,7 +3613,7 @@ Task t Status: RanToCompletion, Result: 42
<Docs>
<typeparam name="TResult">The return type of the task.</typeparam>
<param name="function">The work to execute asynchronously.</param>
<summary>Queues the specified work to run on the thread pool and returns a <see cref="T:System.Threading.Tasks.Task`1" /> object that represents that work.</summary>
<summary>Queues the specified work to run on the thread pool and returns a <see cref="T:System.Threading.Tasks.Task`1" /> object that represents that work. A cancellation token allows the work to be cancelled if it has not yet started.</summary>
<returns>A task object that represents the work queued to execute in the thread pool.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down Expand Up @@ -3688,7 +3688,7 @@ Task t Status: RanToCompletion, Result: 42
<Docs>
<typeparam name="TResult">The type of the result returned by the proxy task.</typeparam>
<param name="function">The work to execute asynchronously</param>
<param name="cancellationToken">A cancellation token that should be used to cancel the work</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the work if it has not yet started. <see cref="Run"/> does not pass <paramref="cancellationToken"/> to <paramref="action"/>.</param>
<summary>Queues the specified work to run on the thread pool and returns a proxy for the <see langword="Task(TResult)" /> returned by <paramref name="function" />.</summary>
<returns>A <see langword="Task(TResult)" /> that represents a proxy for the <see langword="Task(TResult)" /> returned by <paramref name="function" />.</returns>
<remarks>
Expand Down Expand Up @@ -3749,8 +3749,8 @@ Task t Status: RanToCompletion, Result: 42
<Docs>
<typeparam name="TResult">The result type of the task.</typeparam>
<param name="function">The work to execute asynchronously</param>
<param name="cancellationToken">A cancellation token that should be used to cancel the work</param>
<summary>Queues the specified work to run on the thread pool and returns a <see langword="Task(TResult)" /> object that represents that work. A cancellation token allows the work to be cancelled.</summary>
<param name="cancellationToken">A cancellation token that can be used to cancel the work if it has not yet started. <see cref="Run"/> does not pass <paramref="cancellationToken"/> to <paramref="action"/>.</param>
<summary>Queues the specified work to run on the thread pool and returns a <see langword="Task(TResult)" /> object that represents that work.</summary>
<returns>A <see langword="Task(TResult)" /> that represents the work queued to execute in the thread pool.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down