Automatically port System.Text.Json documentation #3795
Conversation
carlossanlop
requested review from
ahsonkhan,
steveharter,
layomia,
jozkee and
a team
xml/System.Text.Json/JsonElement.xml
Outdated
| @@ -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> | |||
There was a problem hiding this comment.
JsonNode hasn't shipped yet (it's new in 5.0), so I would remove this remark for now.
| @@ -517,6 +517,8 @@ For more information, see [How to serialize and deserialize JSON](~/docs/standar | |||
|
|
|||
| ]]></format> | |||
| </remarks> | |||
| <exception cref="T:System.ArgumentNullException"> | |||
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
@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>
The tool found 2 exceptions and 1 remark.