dotnet/runtime

Confusing documentation for `AggregateException.GetBaseException()`

Open

#82 853 ouverte le 1 mars 2023

Voir sur GitHub
 (10 commentaires) (2 réactions) (0 assignés)C# (5 445 forks)batch import
area-System.Runtimedocumentationhelp wanted

Métriques du dépôt

Stars
 (17 886 stars)
Métriques de merge PR
 (Merge moyen 12j 11h) (661 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Le problème pointe vers le commentaire XML pour AggregateException.GetBaseException() à la ligne 215 dans AggregateException.cs. Le commentaire indique actuellement qu'il renvoie une AggregateException, ce qui est incorrect. La correction consiste à mettre à jour le commentaire pour refléter que la méthode peut renvoyer n'importe quel type d'Exception. Aucune modification de code n'est nécessaire.
Stack technique
csharp
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85