Skip to content

Commit 23e4143

Browse files
ManickaPgewarren
andauthored
Apply suggestions from code review
Co-authored-by: Genevieve Warren <[email protected]>
1 parent 6592c14 commit 23e4143

File tree

6 files changed

+10
-10
lines changed

6 files changed

+10
-10
lines changed

xml/System.Net.Quic/QuicConnectionOptions.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -243,8 +243,8 @@ To use a different close error code, call <xref:System.Net.Quic.QuicConnection.C
243243
</summary>
244244
<value>To be added.</value>
245245
<remarks>
246-
<para>The callback values represent increments of stream limits, e.g.: current limit is 10 bidirectional streams, callback arguments notify 5 more additional bidirectional streams =&gt; 15 bidirectional streams can be opened in total at the moment.</para>
247-
<para>The initial capacity is reported with the first invocation of the callback that might happen before the <see cref="T:System.Net.Quic.QuicConnection" /> instance is handed out via either <see cref="M:System.Net.Quic.QuicConnection.ConnectAsync(System.Net.Quic.QuicClientConnectionOptions,System.Threading.CancellationToken)" /> or <see cref="M:System.Net.Quic.QuicListener.AcceptConnectionAsync(System.Threading.CancellationToken)" />.</para>
246+
<para>The callback values represent increments of stream limits. For example, if the current limit is 10 bidirectional streams, and callback arguments notify 5 more additional bidirectional streams, then 15 bidirectional streams can be opened in total at the moment.</para>
247+
<para>The initial capacity is reported with the first invocation of the callback, which might happen before the <see cref="T:System.Net.Quic.QuicConnection" /> instance is handed out via either <see cref="M:System.Net.Quic.QuicConnection.ConnectAsync(System.Net.Quic.QuicClientConnectionOptions,System.Threading.CancellationToken)" /> or <see cref="M:System.Net.Quic.QuicListener.AcceptConnectionAsync(System.Threading.CancellationToken)" />.</para>
248248
</remarks>
249249
</Docs>
250250
</Member>

xml/System.Net.Quic/QuicListener.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ For QUIC prerequisites and supported operating systems, see [Platform dependenci
3939
]]></format>
4040
</remarks>
4141
<related type="Article" href="https://www.rfc-editor.org/rfc/rfc9000.html#name-connections">RFC 9000: Connections</related>
42-
<related type="ExternalDocumentation" href="/dotnet/fundamentals/networking/quic/quic-overview#quiclistener">Guidelines for using QuicListener</related>
42+
<related type="Article" href="/dotnet/fundamentals/networking/quic/quic-overview#quiclistener">Guidelines for using QuicListener</related>
4343
</Docs>
4444
<Members>
4545
<Member MemberName="AcceptConnectionAsync">

xml/System.Net.Quic/QuicListenerOptions.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
<Docs>
2525
<summary>Options to configure a new <see cref="T:System.Net.Quic.QuicListener" />.</summary>
2626
<remarks>To be added.</remarks>
27-
<related type="ExternalDocumentation" href="/dotnet/fundamentals/networking/quic/quic-options#quiclisteneroptions">Detailed documentation for QuicListenerOptions</related>
27+
<related type="Article" href="/dotnet/fundamentals/networking/quic/quic-options#quiclisteneroptions">Detailed documentation for QuicListenerOptions</related>
2828
</Docs>
2929
<Members>
3030
<Member MemberName=".ctor">
@@ -66,7 +66,7 @@
6666
<Docs>
6767
<summary>Gets or sets the list of application protocols that the listener will accept. At least one must be specified.</summary>
6868
<value>To be added.</value>
69-
<remarks>This property is mandatory, not setting or not specifying at least one value will result in validation errors when starting the listener.</remarks>
69+
<remarks>This property is mandatory. Not setting it or not specifying at least one value will result in validation errors when starting the listener.</remarks>
7070
</Docs>
7171
</Member>
7272
<Member MemberName="ConnectionOptionsCallback">
@@ -95,7 +95,7 @@
9595
<Docs>
9696
<summary>Gets or sets the selection callback to choose inbound connection options.</summary>
9797
<value>To be added.</value>
98-
<remarks>This property is mandatory, not setting it will result in validation errors when starting the listener.</remarks>
98+
<remarks>This property is mandatory. Not setting it will result in validation errors when starting the listener.</remarks>
9999
</Docs>
100100
</Member>
101101
<Member MemberName="ListenBacklog">
@@ -141,7 +141,7 @@
141141
<Docs>
142142
<summary>Gets or sets the endpoint to listen on.</summary>
143143
<value>To be added.</value>
144-
<remarks>This property is mandatory, not setting will result in validation errors when starting the listener.</remarks>
144+
<remarks>This property is mandatory. Not setting it will result in validation errors when starting the listener.</remarks>
145145
</Docs>
146146
</Member>
147147
</Members>

xml/System.Net.Quic/QuicServerConnectionOptions.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
<Docs>
2525
<summary>Options for server (inbound) <see cref="T:System.Net.Quic.QuicConnection">Quic connections</see>. These options are provided by <see cref="P:System.Net.Quic.QuicListenerOptions.ConnectionOptionsCallback" />.</summary>
2626
<remarks>To be added.</remarks>
27-
<related type="ExternalDocumentation" href="/dotnet/fundamentals/networking/quic/quic-options#quicserverconnectionoptions">Detailed documentation for QuicServerConnectionOptions</related>
27+
<related type="Article" href="/dotnet/fundamentals/networking/quic/quic-options#quicserverconnectionoptions">Detailed documentation for QuicServerConnectionOptions</related>
2828
</Docs>
2929
<Members>
3030
<Member MemberName=".ctor">

xml/System.Net.Quic/QuicStream.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Apart from a stream API, <see cref="T:System.Net.Quic.QuicStream" /> also expose
3030

3131
<list type="bullet"><item><term><see cref="M:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Boolean,System.Threading.CancellationToken)" /></term><description>Closes the writing side of the stream as a single operation with the write itself.</description></item><item><term><see cref="M:System.Net.Quic.QuicStream.CompleteWrites" /></term><description>Closes the writing side of the stream.</description></item><item><term><see cref="M:System.Net.Quic.QuicStream.Abort(System.Net.Quic.QuicAbortDirection,System.Int64)" /></term><description>Aborts either the writing or the reading side of the stream.</description></item><item><term><see cref="M:System.Net.Quic.QuicStream.WritesClosed" /></term><description>Returns a <see cref="T:System.Threading.Tasks.Task" /> that will complete when the stream writing side has been closed (gracefully or abortively).</description></item><item><term><see cref="P:System.Net.Quic.QuicStream.ReadsClosed" /></term><description>Returns a <see cref="T:System.Threading.Tasks.Task" /> that will complete when the stream reading side has been closed (gracefully or abortively).</description></item></list></remarks>
3232
<related type="Article" href="https://www.rfc-editor.org/rfc/rfc9000.html#name-streams">RFC 9000: Streams</related>
33-
<related type="ExternalDocumentation" href="/dotnet/fundamentals/networking/quic/quic-overview#quicstream">Guidelines for using QuicStream</related>
33+
<related type="Article" href="/dotnet/fundamentals/networking/quic/quic-overview#quicstream">Guidelines for using QuicStream</related>
3434
</Docs>
3535
<Members>
3636
<Member MemberName="Abort">

xml/ns-System.Net.Quic.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
<Docs>
33
<summary>Contains types that implement the QUIC protocol specified by <see href="https://www.rfc-editor.org/rfc/rfc9000.html">RFC 9000</see>.</summary>
44
<remarks>To be added.</remarks>
5-
<related type="ExternalDocumentation" href="/dotnet/fundamentals/networking/quic/quic-overview">QUIC in .NET</related>
5+
<related type="Article" href="/dotnet/fundamentals/networking/quic/quic-overview">QUIC in .NET</related>
66
</Docs>
77
</Namespace>

0 commit comments

Comments
 (0)