dotnet/runtime

Confusing documentation for `AggregateException.GetBaseException()`

Open

#82.853 geöffnet am 1. März 2023

Auf GitHub ansehen
 (10 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)C# (5.445 Forks)batch import
area-System.Runtimedocumentationhelp wanted

Repository-Metriken

Stars
 (17.886 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 12T 11h) (661 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Das Problem verweist auf den XML Kommentar für AggregateException.GetBaseException() in Zeile 215 in AggregateException.cs. Der Kommentar besagt derzeit, dass er eine AggregateException zurückgibt, was falsch ist. Die Korrektur besteht darin, den Kommentar so zu aktualisieren, dass er widerspiegelt, dass die Methode jeden Exception Typ zurückgeben kann. Es sind keine Codeänderungen erforderlich.
Tech Stack
csharp
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85