Update Utf8JsonWriter for null strings, double/single formatting, and consistency. #3143

ahsonkhan · 2019-09-09T04:25:30Z

Also updated JsonReaderOptions and JsonWriterOptions to fix some nits.

consistency.

xml/System.Text.Json/Utf8JsonWriter.xml

ahsonkhan · 2019-09-09T04:26:11Z

xml/System.Text.Json/Utf8JsonWriter.xml

-        <summary>Gets the custom behavior when writing JSON using this instance, which indicates whether to format the output while writing and whether to skip structural JSON validation.</summary>
-        <value>An object that defines the behavior of this instance for formatting and validation.</value>
+        <summary>Gets the custom behavior when writing JSON using this instance, which indicates whether to format the output while writing, whether to skip structural JSON validation, and which characters to escape.</summary>
+        <value>Defines the behavior of this instance of the writer for formatting, validation, and escaping.</value>


JsonWriterOptions is a struct, not a class.

It's my understanding that <value> needs to explain the data type and what it represents. So you could prepend it with "struct instance" for example. Also, as I mentioned in your other PR, in our official docs for "C# objects", it seems that we use "object" to describe a struct instance too.

Maybe something like this? It shouldn't start with a verb here.

Suggested change

<value>Defines the behavior of this instance of the writer for formatting, validation, and escaping.</value>

<value>The custom behavior of this instance of the writer for formatting, validating, and escaping.</value>

xml/System.Text.Json/JsonReaderOptions.xml

xml/System.Text.Json/Utf8JsonWriter.xml

ahsonkhan · 2019-09-09T04:29:28Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -3155,6 +3155,8 @@ The property name and value are escaped before writing.

 The property name and value are escaped before writing.

+If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(System.ReadOnlySpan{byte})"/> was called.


Addressing recent changes around "null:
#3081 (comment)

This PR updated the description around nulls in a few places. We should make sure to capture that:
dotnet/corefx#39344

Suggested change

If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(System.ReadOnlySpan{byte})"/> was called.

If `value` is `null`, the JSON null value is written as if the <xref:System.Text.Json.Utf8JsonWriter.WriteNull(System.ReadOnlySpan{System.Byte})"> method was called.

Why not use the langword null here (rather than back-ticks)?

You're in Markdown land here in the remarks.

This is produced if you use that:

Ah I see. Yep, that needs to be fixed. Thanks, @mairaw.

ahsonkhan · 2019-09-09T05:28:18Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -56,7 +56,7 @@ To be able to format the output with indentation and white space OR to skip vali
      <Docs>
        <param name="bufferWriter">The destination for writing JSON text.</param>
        <param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>
-        <summary>Constructs a new <see cref="T:System.Text.Json.Utf8JsonWriter" /> instance with a specified <see langword="System.Buffers.IBufferWriter&lt;System.Byte&gt;" />.</summary>
+        <summary>Constructs a new <see cref="T:System.Text.Json.Utf8JsonWriter" /> instance with a specified <see cref="T:System.Buffers.IBufferWriter`1" /> to write the output to.</summary>


Looks like the build didn't like using

`IBufferWriter<byte>`

So, I decided to use the generic one. Is there a correct way to specify that the T is byte?

See my comment above.

carlossanlop · 2019-09-09T16:51:24Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -80,7 +80,7 @@ To be able to format the output with indentation and white space OR to skip vali
      <Docs>
        <param name="utf8Json">The destination for writing JSON text.</param>
        <param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>
-        <summary>Constructs a new <see cref="T:System.Text.Json.Utf8JsonWriter" /> instance with a specified <paramref name="utf8Json" />.</summary>
+        <summary>Constructs a new <see cref="T:System.Text.Json.Utf8JsonWriter" /> instance with a specified <see cref="T:System.IO.Stream" /> to write the output to.</summary>


We normally mention streams with plain language:

<summary>Constructs a new <see cref="T:System.Text.Json.Utf8JsonWriter" /> instance with a specified stream to write the output to.</summary>

Edit: Use Maira's suggestion below.

I'd add to Carlos suggestion and use the text from our wiki - https://github.com/dotnet/dotnet-api-docs/wiki/Summary%3A-Constructor

Suggested change

<summary>Constructs a new <see cref="T:System.Text.Json.Utf8JsonWriter" /> instance with a specified <see cref="T:System.IO.Stream" /> to write the output to.</summary>

<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> class using the specified stream to write the output to and customization options.</summary>

carlossanlop

Left some changes for you to consider.
Let's also wait for @mairaw / @rpetrusha 's review.

mairaw

Left some comments for you to consider.

mairaw · 2019-09-09T19:01:32Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -56,7 +56,7 @@ To be able to format the output with indentation and white space OR to skip vali
      <Docs>
        <param name="bufferWriter">The destination for writing JSON text.</param>
        <param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>
-        <summary>Constructs a new <see cref="T:System.Text.Json.Utf8JsonWriter" /> instance with a specified <see langword="System.Buffers.IBufferWriter&lt;System.Byte&gt;" />.</summary>
+        <summary>Constructs a new <see cref="T:System.Text.Json.Utf8JsonWriter" /> instance with a specified <see cref="T:System.Buffers.IBufferWriter`1" /> to write the output to.</summary>


Somehow GitHub won't let me do a suggestion for this line but it should be something like:

Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> class using the specified buffer and customization options.

It happens to me to sometimes, @mairaw. Press Control+G on the comment textbox, or manually add the suggestion text. Here's your suggestion:

Suggested change

<summary>Constructs a new <see cref="T:System.Text.Json.Utf8JsonWriter" /> instance with a specified <see cref="T:System.Buffers.IBufferWriter`1" /> to write the output to.</summary>

<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> class using the specified buffer and customization options.</summary>

IBufferWriter isn't a buffer though. I would prefer to keep that as is, and also specify that the IBW is where we are "writing the output to".

Any better way to word it to keep both those things?

mairaw · 2019-09-09T19:03:35Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -80,7 +80,7 @@ To be able to format the output with indentation and white space OR to skip vali
      <Docs>
        <param name="utf8Json">The destination for writing JSON text.</param>
        <param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>
-        <summary>Constructs a new <see cref="T:System.Text.Json.Utf8JsonWriter" /> instance with a specified <paramref name="utf8Json" />.</summary>
+        <summary>Constructs a new <see cref="T:System.Text.Json.Utf8JsonWriter" /> instance with a specified <see cref="T:System.IO.Stream" /> to write the output to.</summary>


I'd add to Carlos suggestion and use the text from our wiki - https://github.com/dotnet/dotnet-api-docs/wiki/Summary%3A-Constructor

Suggested change

<summary>Constructs a new <see cref="T:System.Text.Json.Utf8JsonWriter" /> instance with a specified <see cref="T:System.IO.Stream" /> to write the output to.</summary>

<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> class using the specified stream to write the output to and customization options.</summary>

mairaw · 2019-09-09T19:06:19Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -80,7 +80,7 @@ To be able to format the output with indentation and white space OR to skip vali
      <Docs>
        <param name="utf8Json">The destination for writing JSON text.</param>
        <param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>


Suggested change

<param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>

<param name="options">One of the enumeration values that that defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>

Suggested change

<param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>

<param name="options">One of the enumeration values that that defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" />. By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>

mairaw · 2019-09-09T19:06:36Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -56,7 +56,7 @@ To be able to format the output with indentation and white space OR to skip vali
      <Docs>
        <param name="bufferWriter">The destination for writing JSON text.</param>
        <param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>


Suggested change

<param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>

<param name="options">One of the enumeration values that defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>

Adding missing dot to @mairaw's suggestion.

Suggested change

<param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>

<param name="options">One of the enumeration values that defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" />. By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>

The options isn't an enum though.

mairaw · 2019-09-09T19:07:44Z

xml/System.Text.Json/Utf8JsonWriter.xml

-        <summary>Gets the custom behavior when writing JSON using this instance, which indicates whether to format the output while writing and whether to skip structural JSON validation.</summary>
-        <value>An object that defines the behavior of this instance for formatting and validation.</value>
+        <summary>Gets the custom behavior when writing JSON using this instance, which indicates whether to format the output while writing, whether to skip structural JSON validation, and which characters to escape.</summary>
+        <value>Defines the behavior of this instance of the writer for formatting, validation, and escaping.</value>


Maybe something like this? It shouldn't start with a verb here.

Suggested change

<value>Defines the behavior of this instance of the writer for formatting, validation, and escaping.</value>

<value>The custom behavior of this instance of the writer for formatting, validating, and escaping.</value>

mairaw · 2019-09-09T19:17:16Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -3415,6 +3417,8 @@ The property name and value are escaped before writing.

 The property name and value are escaped before writing.

+If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(System.ReadOnlySpan{char})"/> was called.


Suggested change

If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(System.ReadOnlySpan{char})"/> was called.

If `value` is `null`, the JSON null value is written as if the <xref:System.Text.Json.Utf8JsonWriter.WriteNull(System.ReadOnlySpan{System.Char})"> method was called.

mairaw · 2019-09-09T19:17:54Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -3680,6 +3684,8 @@ The property name and value are escaped before writing.

 The property name and value are escaped before writing.

+If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(string)"/> were called.


Suggested change

If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(string)"/> were called.

If `value` is `null`, the JSON null value is written as if the <xref:System.Text.Json.Utf8JsonWriter.WriteNull(System.String)"> method was called.

mairaw · 2019-09-09T19:18:24Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -3909,6 +3915,8 @@ The property name should already be escaped when the instance of <xref:System.Te

 The value is escaped before writing.

+If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(System.Text.Json.JsonEncodedText)"/> was called.


Suggested change

If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(System.Text.Json.JsonEncodedText)"/> was called.

If `value` is `null`, the JSON null value is written as if the <xref:System.Text.Json.Utf8JsonWriter.WriteNull(System.Text.Json.JsonEncodedText)"> method was called.

mairaw · 2019-09-09T19:18:44Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -3947,6 +3955,8 @@ The property name should already be escaped when the instance of <xref:System.Te

 The value is escaped before writing.

+If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(System.Text.Json.JsonEncodedText)"/> was called.


Suggested change

If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(System.Text.Json.JsonEncodedText)"/> was called.

If `value` is `null`, the JSON null value is written as if the <xref:System.Text.Json.Utf8JsonWriter.WriteNull(System.Text.Json.JsonEncodedText)"> method was called.

mairaw · 2019-09-09T19:19:17Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -4185,6 +4195,8 @@ The value is escaped before writing.

 The value is escaped before writing.

+If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNullValue"/> was called.


Suggested change

If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNullValue"/> was called.

If `value` is `null`, the JSON null value is written as if the <xref:System.Text.Json.Utf8JsonWriter.WriteNullValue"> method was called.

carlossanlop · 2019-09-09T22:49:07Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -821,7 +821,7 @@ The comment value is not escaped before writing.

 -or-

-<paramref name="utf8Value" /> contains a comment delimiter (that is, */).</exception>
+<paramref name="utf8Value" /> contains a comment delimiter (that is, `*/`).</exception>


From Maira's suggestion above, use <c> if it renders correctly after the build finishes:

Suggested change

<paramref name="utf8Value" /> contains a comment delimiter (that is, `*/`).</exception>

<paramref name="utf8Value" /> contains a comment delimiter (that is, <c>*/</c>).</exception>

I'll leave the suggestions to make it easier to commit them.

carlossanlop · 2019-09-09T22:50:10Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -843,7 +843,7 @@ The comment value is not escaped before writing.
        <Parameter Name="value" Type="System.ReadOnlySpan&lt;System.Char&gt;" />
      </Parameters>
      <Docs>
-        <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /*..*/.</param>
+        <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within `/*..*/`.</param>


Suggested change

<param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within `/*..*/`.</param>

<param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within <c>/*..*/</c>.</param>

carlossanlop · 2019-09-09T22:50:25Z

xml/System.Text.Json/Utf8JsonWriter.xml


 -or-

-<paramref name="value" /> contains a comment delimiter (that is, */).</exception>
+<paramref name="value" /> contains a comment delimiter (that is, `*/`).</exception>


Suggested change

<paramref name="value" /> contains a comment delimiter (that is, `*/`).</exception>

<paramref name="value" /> contains a comment delimiter (that is, <c>*/</c>).</exception>

carlossanlop · 2019-09-09T22:50:35Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -880,7 +880,7 @@ The comment value is not escaped before writing.
        <Parameter Name="value" Type="System.String" />
      </Parameters>
      <Docs>
-        <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /*..*/.</param>
+        <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within `/*..*/`.</param>


Suggested change

<param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within `/*..*/`.</param>

<param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within <c>/*..*/</c>.</param>

carlossanlop · 2019-09-09T22:50:46Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -895,7 +895,7 @@ The comment value is not escaped before writing.

 -or-

-<paramref name="value" /> contains a comment delimiter (that is, */).</exception>
+<paramref name="value" /> contains a comment delimiter (that is, `*/`).</exception>


Suggested change

<paramref name="value" /> contains a comment delimiter (that is, `*/`).</exception>

<paramref name="value" /> contains a comment delimiter (that is, <c>*/</c>).</exception>

jozkee · 2019-09-09T23:33:06Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -56,7 +56,7 @@ To be able to format the output with indentation and white space OR to skip vali
      <Docs>
        <param name="bufferWriter">The destination for writing JSON text.</param>
        <param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>


Adding missing dot to @mairaw's suggestion.

Suggested change

<param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>

<param name="options">One of the enumeration values that defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" />. By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>

jozkee · 2019-09-09T23:35:17Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -80,7 +80,7 @@ To be able to format the output with indentation and white space OR to skip vali
      <Docs>
        <param name="utf8Json">The destination for writing JSON text.</param>
        <param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>


Suggested change

<param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>

<param name="options">One of the enumeration values that that defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" />. By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>

jozkee · 2019-09-09T23:39:33Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -383,7 +383,7 @@ The <xref:System.Text.Json.Utf8JsonWriter> will continue to use the original wri

 ## Remarks

-The <xref:System.Text.Json.Utf8JsonWriter> will continue to use the original writer options but now writes to `bufferWriter` as the new destination.
+The <xref:System.Text.Json.Utf8JsonWriter> will continue to use the original writer options but now write to `bufferWriter` as the new destination.


Why did you remove the "s"? Utf8JsonWriter is still a singular.

Seemed to make more grammatical sense to my ear.

I'm on the fence on this one. @rpetrusha can you help?

I agree with @jozkee, The Utf8JsonWriter is who's writing. It writes.

The other option would be to add will write

The tense of write is future, so it should be "write" rather than "writes". As Maira points out, it could also be changed to "will write", and that's fine, but it's not necessary.

ahsonkhan · 2019-09-10T02:22:02Z

Anything left to do or is this good to merge?

mairaw · 2019-09-10T02:53:14Z

xml/System.Text.Json/Utf8JsonWriter.xml

@@ -2756,7 +2756,7 @@ The property name should already be escaped when the instance of <xref:System.Te
        </remarks>
        <exception cref="T:System.InvalidOperationException">The depth of the JSON has exceeded the maximum depth of 1000.


nit: I could also do this in a separate PR

Suggested change

<exception cref="T:System.InvalidOperationException">The depth of the JSON has exceeded the maximum depth of 1000.

<exception cref="T:System.InvalidOperationException">The depth of the JSON has exceeded the maximum depth of 1,000.

mairaw · 2019-09-10T03:56:53Z

I'll merge this and fix the grammar if needed on a separate PR.

Update Utf8JsonWriter for null strings, double/single formatting, and

adceac6

consistency.

ahsonkhan commented Sep 9, 2019

View reviewed changes

xml/System.Text.Json/Utf8JsonWriter.xml Show resolved Hide resolved

ahsonkhan commented Sep 9, 2019

View reviewed changes

xml/System.Text.Json/JsonReaderOptions.xml Show resolved Hide resolved

ahsonkhan commented Sep 9, 2019

View reviewed changes

xml/System.Text.Json/Utf8JsonWriter.xml Show resolved Hide resolved

ahsonkhan commented Sep 9, 2019

View reviewed changes

xml/System.Text.Json/Utf8JsonWriter.xml Show resolved Hide resolved

ahsonkhan commented Sep 9, 2019

View reviewed changes

Fix the IBufferWriter<byte> format since using back-ticks didn't work.

c18f9d9

ahsonkhan commented Sep 9, 2019

View reviewed changes

carlossanlop requested review from rpetrusha, carlossanlop, mairaw, jozkee and steveharter September 9, 2019 16:42

carlossanlop assigned ahsonkhan Sep 9, 2019

carlossanlop added 🏁 Release: .NET Core 3.0 :checkered_flag: Release: .NET Core 3.0 new-content Indicates PRs that contain new articles waiting-on-reviews Indicates PRs that cannot be merged because of the lack of reviews labels Sep 9, 2019

carlossanlop added this to the September 2019 milestone Sep 9, 2019

carlossanlop reviewed Sep 9, 2019

View reviewed changes

carlossanlop suggested changes Sep 9, 2019

View reviewed changes

mairaw requested changes Sep 9, 2019

View reviewed changes

mairaw added doc-enhancement Improve the current content and removed new-content Indicates PRs that contain new articles labels Sep 9, 2019

carlossanlop reviewed Sep 9, 2019

View reviewed changes

jozkee reviewed Sep 9, 2019

View reviewed changes

Address PR feedback.

4440982

mairaw reviewed Sep 10, 2019

View reviewed changes

mairaw approved these changes Sep 10, 2019

View reviewed changes

carlossanlop approved these changes Sep 10, 2019

View reviewed changes

mairaw merged commit d434b4c into dotnet:master Sep 10, 2019

ahsonkhan deleted the UpdateUtf8JsonWriterDocs branch September 10, 2019 04:35

ahsonkhan mentioned this pull request Sep 10, 2019

adding s back #3157

Merged

mairaw removed the waiting-on-reviews Indicates PRs that cannot be merged because of the lack of reviews label Sep 10, 2019

	<value>Defines the behavior of this instance of the writer for formatting, validation, and escaping.</value>
	<value>The custom behavior of this instance of the writer for formatting, validating, and escaping.</value>

		@@ -3155,6 +3155,8 @@ The property name and value are escaped before writing.

		The property name and value are escaped before writing.

		If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(System.ReadOnlySpan{byte})"/> was called.

	If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(System.ReadOnlySpan{byte})"/> was called.
	If `value` is `null`, the JSON null value is written as if the <xref:System.Text.Json.Utf8JsonWriter.WriteNull(System.ReadOnlySpan{System.Byte})"> method was called.

	<summary>Constructs a new <see cref="T:System.Text.Json.Utf8JsonWriter" /> instance with a specified <see cref="T:System.IO.Stream" /> to write the output to.</summary>
	<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> class using the specified stream to write the output to and customization options.</summary>

	<param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>
	<param name="options">One of the enumeration values that that defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>

		@@ -3415,6 +3417,8 @@ The property name and value are escaped before writing.

		The property name and value are escaped before writing.

		If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(System.ReadOnlySpan{char})"/> was called.

		@@ -3680,6 +3684,8 @@ The property name and value are escaped before writing.

		The property name and value are escaped before writing.

		If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(string)"/> were called.

		@@ -3909,6 +3915,8 @@ The property name should already be escaped when the instance of <xref:System.Te

		The value is escaped before writing.

		If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(System.Text.Json.JsonEncodedText)"/> was called.

		@@ -3947,6 +3955,8 @@ The property name should already be escaped when the instance of <xref:System.Te

		The value is escaped before writing.

		If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNull(System.Text.Json.JsonEncodedText)"/> was called.

		@@ -4185,6 +4195,8 @@ The value is escaped before writing.

		The value is escaped before writing.

		If <paramref name="value"/> is <see langword="null"/> the JSON null value is written, as if <see cref="WriteNullValue"/> was called.

	<paramref name="utf8Value" /> contains a comment delimiter (that is, `*/`).</exception>
	<paramref name="utf8Value" /> contains a comment delimiter (that is, <c>*/</c>).</exception>

	<param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within `/../`.</param>
	<param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within <c>/../</c>.</param>

	<paramref name="value" /> contains a comment delimiter (that is, `*/`).</exception>
	<paramref name="value" /> contains a comment delimiter (that is, <c>*/</c>).</exception>

		@@ -2756,7 +2756,7 @@ The property name should already be escaped when the instance of <xref:System.Te
		</remarks>
		<exception cref="T:System.InvalidOperationException">The depth of the JSON has exceeded the maximum depth of 1000.

Update Utf8JsonWriter for null strings, double/single formatting, and consistency. #3143

Update Utf8JsonWriter for null strings, double/single formatting, and consistency. #3143

Uh oh!

Conversation

ahsonkhan commented Sep 9, 2019

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

carlossanlop Sep 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

carlossanlop left a comment

Choose a reason for hiding this comment

Uh oh!

mairaw left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

carlossanlop Sep 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

carlossanlop Sep 9, 2019 •

edited

Loading

carlossanlop Sep 9, 2019 •

edited

Loading

jozkee Sep 9, 2019 •

edited

Loading