Skip to content

Add missing System.Text.Json API docs - #7180

Merged
eiriktsarpalis merged 1 commit into
dotnet:net6-rc1from
eiriktsarpalis:document-missing-json-apis
Sep 14, 2021
Merged

eiriktsarpalis merged 1 commit into
dotnet:net6-rc1from
eiriktsarpalis:document-missing-json-apis

Conversation

@eiriktsarpalis

@eiriktsarpalis eiriktsarpalis commented Sep 14, 2021 •

Copy link
Copy Markdown
Member

Should put dotnet/runtime#54862 to rest.

@ghost

ghost commented Sep 14, 2021

Copy link
Copy Markdown

Tagging subscribers to this area: @eiriktsarpalis, @layomia
See info in area-owners.md if you want to be subscribed.

Issue Details

Should put #7179 to rest.

Author: eiriktsarpalis
Assignees: -
Labels:

area-System.Text.Json

Milestone: -

@eiriktsarpalis eiriktsarpalis changed the title Add missing System.Text.Json APIs Add missing System.Text.Json API docs Sep 14, 2021
@opbld31

opbld31 commented Sep 14, 2021

Copy link
Copy Markdown

Docs Build status updates of commit bb0830a:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Text.Json.Nodes/JsonArray.xml ✅Succeeded View
xml/System.Text.Json.Nodes/JsonNode.xml ✅Succeeded View
xml/System.Text.Json.Nodes/JsonObject.xml ✅Succeeded View
xml/System.Text.Json.Serialization/JsonSourceGenerationOptionsAttribute.xml ✅Succeeded View
xml/System.Text.Json/JsonSerializer.xml ✅Succeeded View
xml/ns-System.Text.Json.Nodes.xml ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@eiriktsarpalis
eiriktsarpalis merged commit b2e7093 into dotnet:net6-rc1 Sep 14, 2021
@eiriktsarpalis
eiriktsarpalis deleted the document-missing-json-apis branch September 14, 2021 14:19

@carlossanlop carlossanlop left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Just wanted to point out two things.

<summary>Write the <see cref="T:System.Text.Json.Nodes.JsonNode" /> into the provided <see cref="T:System.Text.Json.Utf8JsonWriter" /> as JSON.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> parameter is <see langword="null" />.</exception>
<remarks>To be added.</remarks>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remarks go before exceptions. I suspect the build will revert this automatically.

<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TValue" />

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this removal is fine since it didn't change between versions. Otherwise, we would be seeing a moniker attribute here.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I should open a bug so the Docs build system is capable of removing these extra typeparameters that got renamed in the same version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants