Skip to content

Commit bf9220f

Browse files
ahsonkhanBillWagner
authored andcommitted
Resolve leftover feedback for IBufferWriter (#1963)
Update the docs based on feedback from #1949 / dotnet/corefx#35554
1 parent d40c4c5 commit bf9220f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

xml/System.Buffers/IBufferWriter`1.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<Interfaces />
1818
<Docs>
1919
<typeparam name="T">The type of the items in the <see cref="T:System.Buffers.IBufferWriter`1" />.</typeparam>
20-
<summary>Represents a <typeparamref name="T" /> output sink into which data can be written.</summary>
20+
<summary>Represents an output sink into which <typeparamref name="T" /> data can be written.</summary>
2121
<remarks>To be added.</remarks>
2222
</Docs>
2323
<Members>
@@ -67,15 +67,15 @@
6767
<Parameter Name="sizeHint" Type="System.Int32" />
6868
</Parameters>
6969
<Docs>
70-
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Memory`1" />. If 0, some, non-empty buffer is returned. </param>
70+
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Memory`1" />. If 0, a non-empty buffer is returned. </param>
7171
<summary>Returns a <see cref="T:System.Memory`1" /> to write to that is at least the requested size (specified by <paramref name="sizeHint" />).</summary>
7272
<returns>A <see cref="T:System.Memory`1" /> of at least the size <paramref name="sizeHint" />. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer.</returns>
7373
<remarks>
7474
<format type="text/markdown"><![CDATA[
7575
7676
There is no guarantee that successive calls will return the same buffer or the same-sized buffer.
7777
78-
This must never return <xref:System.Span%601.Empty?displayProperty=nameWithType>, but it can throw <xref:System.OutOfMemoryException> if the requested buffer size is not available.
78+
This must never return <xref:System.Span%601.Empty?displayProperty=nameWithType>, but it can throw if the requested buffer size is not available.
7979
8080
You must request a new buffer after calling `Advance` to continue writing more data; you cannot write to a previously acquired buffer.
8181
@@ -104,15 +104,15 @@ You must request a new buffer after calling `Advance` to continue writing more d
104104
<Parameter Name="sizeHint" Type="System.Int32" />
105105
</Parameters>
106106
<Docs>
107-
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Span`1" />. If 0, some, non-empty buffer is returned. </param>
107+
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Span`1" />. If 0, a non-empty buffer is returned. </param>
108108
<summary>Returns a <see cref="T:System.Span`1" /> to write to that is at least the requested size (specified by <paramref name="sizeHint" />).</summary>
109109
<returns>A <see cref="T:System.Span`1" /> of at least the size <paramref name="sizeHint" />. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer.</returns>
110110
<remarks>
111111
<format type="text/markdown"><![CDATA[
112112
113113
There is no guarantee that successive calls will return the same buffer or the same-sized buffer.
114114
115-
This method must never return <xref:System.Span%601.Empty?displayProperty=nameWithType>, but it can throw <xref:System.OutOfMemoryException> if the requested buffer size is not available.
115+
This method must never return <xref:System.Span%601.Empty?displayProperty=nameWithType>, but it can throw if the requested buffer size is not available.
116116
117117
You must request a new buffer after calling `Advance` to continue writing more data; you cannot write to a previously acquired buffer.
118118
]]></format>

0 commit comments

Comments
 (0)