[System.Text.Json] Utf8JsonReader doc incorrectly uses phrases "last processed JSON token", "next JSON token" as synonyms for "current JSON token"
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- csharp
- Domain
- documentation
Research direction
Search the API documentation sources for System.Text.Json.Utf8JsonReader and the phrases "last processed JSON token" and "next JSON token". Review the affected member pages, replace references to the current token with consistent wording, and verify that the Get???() and other member documentation no longer describes them as reading the next token.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- C#
- Stars
- 950
- Forks
- 1.7k
- Avg merge
- 3d 5h
- Merged PRs (30d)
- 38
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from dotnet/dotnet-api-docs
-
untriaged
Difficulty 1/5 Under an hour Newbie friendliness 88/100
dotnet/dotnet-api-docs#13039 · 1 comment ·
-
DisplayAttribute string properties: Remarks incorrectly state the property performs resource lookup Openarea-System.ComponentModel.DataAnnotations untriaged
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
dotnet/dotnet-api-docs#13023 · 1 comment ·
-
area-System.Net.Sockets untriaged
Difficulty 1/5 Under an hour Newbie friendliness 88/100
dotnet/dotnet-api-docs#13022 · 1 comment ·
-
area-System.Runtime untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
dotnet/dotnet-api-docs#13015 · 1 comment ·
-
area-System.Runtime.InteropServices untriaged
Difficulty 1/5 Under an hour Newbie friendliness 84/100
dotnet/dotnet-api-docs#12959 ·
All issues in dotnet/dotnet-api-docs
Similar issues
-
type/automation type/tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
t/bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
ci-failure-cause test-failure
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area:auth FE mvp P3
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
klasolsson81/jobbliggaren#1788 ·