dotnet / dotnet/dotnet-api-docs
Missing doc for JsonSerializer.DeserializeAsync returns
- Vorherrschende Sprache
- C#
- Sterne
- 949
- Forks
- 1.7k
- Ø Merge
- 2 T. 19 Std.
- Gemergte PRs (30 T.)
- 52
Beschreibung
Hi,
In the generic methods, the return type is nullable, but there is no documentation on how it is possible. Is it possible?
Also, it is minor, but the sections `Exceptions` aren't formatted the same way in the 5 methods: exceptions aren't in the same order and the JsonException have 2 different look.
Article: https://learn.microsoft.com/dotnet/api/system.text.json.jsonserializer.deserializeasync?view=net-8.0
Beitragsleitfaden
Rechercherichtung
Beginne mit dem verlinkten API-Artikel zu JsonSerializer.DeserializeAsync und vergleiche die fünf generischen Methodeneinträge. Überprüfe deren Abschnitte zu Rückgabewert und Ausnahmen und aktualisiere anschließend die Dokumentation, sodass das Verhalten bei nullable Rückgabewerten erklärt wird und die Reihenfolge der Ausnahmen sowie die Formatierung von JsonException bei allen fünf Methoden konsistent sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- csharp
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100