Skip to content

Fix and Update the summary for AggregateException.Flatten() #13049

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
bb-froggy wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix and Update the summary for AggregateException.Flatten() #13049

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
2 changes: 1 addition & 1 deletion xml/System/AggregateException.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -529,7 +529,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>Flattens an <see cref="T:System.AggregateException" /> instances into a single, new instance.</summary>
<summary>Flattens a tree of <see cref="T:System.AggregateException" /> instances into a single, new instance.</summary>

@tannergooding tannergooding Sep 1, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

an was arguably correct, this renders as

Flattens an AggregateException instances into a single, new instance.

i.e. an AggregateException

The mistake here is likely in the use of instances, particularly given that "tree" has its own implications and that may not at all be what this is.

If this were to be reworded for clarity, maybe it should instead focus on what its actually doing here, which is pulling InnerExceptions, checking if any are AggregateException, and if so pulling its InnerExceptions up (recursively). -- Correspondingly, if this represents a graph with a cycle, it can fault.

<returns>A new, flattened <see cref="T:System.AggregateException" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down
Loading