dotnet/runtime

Confusing documentation for `AggregateException.GetBaseException()`

Open

#82,853 opened on Mar 1, 2023

View on GitHub
 (10 comments) (2 reactions) (0 assignees)C# (5,445 forks)batch import
area-System.Runtimedocumentationhelp wanted

Repository metrics

Stars
 (17,886 stars)
PR merge metrics
 (Avg merge 12d 11h) (661 merged PRs in 30d)

Description

The comment for AggregateException.GetBaseException() says it returns an AggregateException, which is not always (or even usually) the case.

Contributor guide

Research direction
Read the current XML comment for AggregateException.GetBaseException() and update it to accurately describe the method's behavior, noting that it returns the actual exception type (e.g., InnerException) rather than always an AggregateException.
Tech stack
csharp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85