Skip to content

Remove .NET Framework remarks (System.Threading) #12652

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
gewarren wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Remove .NET Framework remarks (System.Threading) #12652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
644da24
remove .net fw remarks
gewarren May 24, 2026
6925025
Apply suggestions from code review
gewarren May 27, 2026
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
8 changes: 4 additions & 4 deletions xml/System.Threading.Tasks/Task.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3019,7 +3019,7 @@ Task t Status: RanToCompletion, Result: 42
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Threading.Tasks.Task> class implements the <xref:System.IDisposable> interface because internally it uses resources that also implement <xref:System.IDisposable>. However, particularly if your app targets .NET Framework 4.5 or later, there is no need to call <xref:System.Threading.Tasks.Task.Dispose*> unless performance or scalability testing indicates that, based on your usage patterns, your app's performance would be improved by disposing of tasks. For more information, see [Do I need to dispose of Tasks?](https://devblogs.microsoft.com/pfxteam/do-i-need-to-dispose-of-tasks/) in the Parallel Programming with .NET blog.
The <xref:System.Threading.Tasks.Task> class implements the <xref:System.IDisposable> interface because internally it uses resources that also implement <xref:System.IDisposable>. However, there is no need to call <xref:System.Threading.Tasks.Task.Dispose*> unless performance or scalability testing indicates that, based on your usage patterns, your app's performance would be improved by disposing of tasks. For more information, see [Do I need to dispose of Tasks?](https://devblogs.microsoft.com/pfxteam/do-i-need-to-dispose-of-tasks/) in the Parallel Programming with .NET blog.

]]></format>
</remarks>
Expand Down Expand Up @@ -3073,7 +3073,7 @@ Task t Status: RanToCompletion, Result: 42
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Threading.Tasks.Task> class implements the <xref:System.IDisposable> interface because internally it uses resources that also implement <xref:System.IDisposable>. However, particularly if your app targets .NET Framework 4.5 or later, there is no need to call <xref:System.Threading.Tasks.Task.Dispose*> unless performance or scalability testing indicates that, based on your usage patterns, your app's performance would be improved by disposing of tasks. For more information, see [Do I need to dispose of Tasks?](https://devblogs.microsoft.com/pfxteam/do-i-need-to-dispose-of-tasks/) in the Parallel Programming with .NET blog.
The <xref:System.Threading.Tasks.Task> class implements the <xref:System.IDisposable> interface because internally it uses resources that also implement <xref:System.IDisposable>. However, there is no need to call <xref:System.Threading.Tasks.Task.Dispose*> unless performance or scalability testing indicates that, based on your usage patterns, your app's performance would be improved by disposing of tasks. For more information, see [Do I need to dispose of Tasks?](https://devblogs.microsoft.com/pfxteam/do-i-need-to-dispose-of-tasks/) in the Parallel Programming with .NET blog.

]]></format>
</remarks>
Expand Down Expand Up @@ -3134,7 +3134,7 @@ Task t Status: RanToCompletion, Result: 42
<format type="text/markdown"><![CDATA[

## Remarks
Tasks that throw unhandled exceptions store the resulting exception and propagate it wrapped in a <xref:System.AggregateException> in calls to <xref:System.Threading.Tasks.Task.Wait*> or in accesses to the <xref:System.Threading.Tasks.Task.Exception> property. On .NET Framework 4.0, any exceptions not observed by the time the task instance is garbage collected will be propagated on the finalizer thread, which crashes the process. On .NET Framework 4.5 and later the default behavior changed so unobserved exceptions are not rethrown from the Finalizer. .NET Core does not rethrow the exception on the Finalizer. For more information and an example, see [Exception Handling (Task Parallel Library)](/dotnet/standard/parallel-programming/exception-handling-task-parallel-library).
Tasks that throw unhandled exceptions store the resulting exception and propagate it wrapped in a <xref:System.AggregateException> in calls to <xref:System.Threading.Tasks.Task.Wait*> or in accesses to the <xref:System.Threading.Tasks.Task.Exception> property. Unobserved exceptions are not rethrown from the Finalizer. For more information and an example, see [Exception Handling (Task Parallel Library)](/dotnet/standard/parallel-programming/exception-handling-task-parallel-library).

]]></format>
</remarks>
Expand Down Expand Up @@ -3198,7 +3198,7 @@ Task t Status: RanToCompletion, Result: 42
The most common use of this property is to create and start a new task in a single call to the <xref:System.Threading.Tasks.TaskFactory.StartNew*?displayProperty=nameWithType> method.

> [!NOTE]
> Starting with .NET Framework 4.5, the <xref:System.Threading.Tasks.Task.Run*?displayProperty=nameWithType> method provides the easiest way to create a <xref:System.Threading.Tasks.Task> object with default configuration values.
> The <xref:System.Threading.Tasks.Task.Run*?displayProperty=nameWithType> method provides the easiest way to create a <xref:System.Threading.Tasks.Task> object with default configuration values.

The following example uses the static <xref:System.Threading.Tasks.Task.Factory> property to make two calls to the <xref:System.Threading.Tasks.TaskFactory.StartNew*?displayProperty=nameWithType> method. The first populates an array with the names of files in the user's MyDocuments directory, while the second populates an array with the names of subdirectories of the user's MyDocuments directory. It then calls the <xref:System.Threading.Tasks.TaskFactory.ContinueWhenAll(System.Threading.Tasks.Task[],System.Action{System.Threading.Tasks.Task[]})?displayProperty=nameWithType> method, which displays information about the number of files and directories in the two arrays after the first two tasks have completed execution.

Expand Down
4 changes: 1 addition & 3 deletions xml/System.Threading.Tasks/TaskCreationOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,9 +392,7 @@
</ReturnValue>
<MemberValue>64</MemberValue>
<Docs>
<summary>Forces continuations added to the current task to be executed asynchronously.

Note that the <see cref="F:System.Threading.Tasks.TaskCreationOptions.RunContinuationsAsynchronously" /> member is available in the <see cref="T:System.Threading.Tasks.TaskCreationOptions" /> enumeration starting with the .NET Framework 4.6.</summary>
<summary>Forces continuations added to the current task to be executed asynchronously.</summary>
</Docs>
</Member>
</Members>
Expand Down
Loading
Loading