dotnet / dotnet/dotnet-api-docs

[System.Text.Json] Utf8JsonReader doc incorrectly uses phrases "last processed JSON token", "next JSON token" as synonyms for "current JSON token"

Aperta Adatta ai principianti
#8,762 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
area-System.Text.Json Pri3
Lingua principale
C#
Stelle
949
Fork
1.7k
Merge medio
2g 19h
PR unite (30g)
52

Descrizione

The API documentation pages for various `System.Text.Json.Utf8JsonReader` members apparently use both the phrases "_last processed JSON token_" and "_next JSON token_" to refer to the current JSON token. (https://learn.microsoft.com/en-us/dotnet/api/system.text.json.utf8jsonreader)

For many of the `Get???()` methods, the documentation incorrectly talks about "_Reads the next JSON token value from the source [...]_", which is simply false. Only the `Read()` method reads the next JSON token. (The documentation for the corresponding `TryGet???()` methods on the other hand correctly state "_Tries to parse the current JSON token value [...]_".)

And the documentation pages for various other members refer to the "_last processed JSON token_" instead of referring to the "_current JSON token_". While the meanings of these two phrases overlap somewhat, they are not perfectly equivalent phrases and therefore using both interchangeably can potentially sow confusion.

I would therefore like to suggest that all documentation pages for `System.Text.Json.Utf8JsonReader` use only the phrase "_current JSON token_" when referring to the current JSON token.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Cerca nelle fonti della documentazione dell'API System.Text.Json.Utf8JsonReader e le frasi "last processed JSON token" e "next JSON token". Esamina le pagine dei membri interessati, sostituisci i riferimenti al token corrente con una formulazione coerente e verifica che la documentazione di Get???() e degli altri membri non li descriva più come se leggessero il token successivo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
72/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.