Skip to content

Automatically port System.Text.Json documentation #3795

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 23, 2020
Merged

Automatically port System.Text.Json documentation #3795

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16c0a18
Automatically port System.Text.Json documentation
carlossanlop Jan 23, 2020
9b7728c
Reset remark
carlossanlop Jan 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion xml/System.Text.Json/JsonElement.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -652,7 +652,15 @@ If a property is defined multiple times for the same object, the method matches
<Docs>
<summary>Gets a string that represents the original input data backing this value.</summary>
<returns>The original input data backing this value.</returns>
<remarks>To be added.</remarks>
<remarks>
Copy link
Contributor

Choose a reason for hiding this comment

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

JsonNode hasn't shipped yet (it's new in 5.0), so I would remove this remark for now.

<format type="text/markdown"><![CDATA[

## Remarks

For a <xref:System.Text.Json.JsonElement> built from a <xref:System.Text.Json.JsonNode>, the value of <xref:System.Text.Json.JsonNode.ToJsonString> is returned.

]]></format>
</remarks>
<exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
</Docs>
</Member>
Expand Down
4 changes: 4 additions & 0 deletions xml/System.Text.Json/JsonSerializer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,6 +517,8 @@ For more information, see [How to serialize and deserialize JSON](~/docs/standar

]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be on one line? Does it make a difference one way or another?

Asking because it was brought up earlier: dotnet/corefx#42026 (comment)

Copy link
Contributor

Choose a reason for hiding this comment

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

One line when it starts with text, like this when it starts with a tag. Just to avoid having the CI touching this file with no need. But it doesn't matter really.

Copy link
Contributor

Choose a reason for hiding this comment

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

So, we should leave it as is then (so that CI doesn't have to modify this file again). Sounds good.

One line when it starts with text,

Can you give me an example of that?

Copy link
Contributor Author

@carlossanlop carlossanlop Jan 23, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

@ahsonkhan Example of a line starting with just text:

<exception cref="ArgumentException">I started with text.</exception>

In contrast with a line starting with a tag:

<exception cref="ArgumentException"><paramref name="lookAtMe" /> I started with a param tag.</exception>

<paramref name="writer" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="Serialize&lt;TValue&gt;">
Expand Down Expand Up @@ -600,6 +602,8 @@ For more information, see [How to serialize and deserialize JSON](~/docs/standar

]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="writer" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="SerializeAsync">
Expand Down