Skip to content

Commit 81daf02

Browse files
Apply suggestions from code review
Co-authored-by: Genevieve Warren <[email protected]>
1 parent fc67ff7 commit 81daf02

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

xml/System.IO.Compression/BrotliCompressionOptions.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@
5252
</ReturnValue>
5353
<Docs>
5454
<summary>Gets or sets the compression quality for a Brotli compression stream.</summary>
55-
<value>To be added.</value>
56-
<remarks>The higher the quality, the slower the compression. Range is from 0 to 11. The default value is 4.</remarks>
55+
<value>The compression quality for a Brotli compression stream. The default value is 4.</value>
56+
<remarks>The higher the quality, the slower the compression. The range is from 0 to 11.</remarks>
5757
<exception cref="T:System.ArgumentOutOfRangeException">The value is less than 0 or greater than 11.</exception>
5858
</Docs>
5959
</Member>

xml/System.IO.Compression/ZLibCompressionOptions.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>Provides compression options to be used with <see cref="T:System.IO.Compression.ZLibStream" />, <see cref="T:System.IO.Compression.DeflateStream" /> and <see cref="T:System.IO.Compression.GZipStream" />.</summary>
17+
<summary>Provides compression options to be used with <see cref="T:System.IO.Compression.ZLibStream" />, <see cref="T:System.IO.Compression.DeflateStream" />, and <see cref="T:System.IO.Compression.GZipStream" />.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -52,10 +52,10 @@
5252
</ReturnValue>
5353
<Docs>
5454
<summary>Gets or sets the compression level for a compression stream.</summary>
55-
<value>To be added.</value>
55+
<value>The compression level for a compression stream. The default value is -1.</value>
5656
<remarks>
57-
<para>Can accept any value between -1 and 9 (inclusive), 0 gives no compression, 1 gives best speed, 9 gives best compression.</para>
58-
<para>and -1 requests the default compression level which is currently equivalent to 6. The default value is -1.</para>
57+
<para>Can accept any value between -1 and 9 (inclusive). 0 gives no compression, 1 gives best speed, 9 gives best compression,</para>
58+
<para>and -1 requests the default compression level, which is equivalent to 6.</para>
5959
</remarks>
6060
<exception cref="T:System.ArgumentOutOfRangeException">The value is less than -1 or greater than 9.</exception>
6161
</Docs>

xml/System.IO.Compression/ZLibCompressionStrategy.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<BaseTypeName>System.Enum</BaseTypeName>
1414
</Base>
1515
<Docs>
16-
<summary>Defines the compression algorithms that can be used for <see cref="T:System.IO.Compression.DeflateStream" />, <see cref="T:System.IO.Compression.GZipStream" /> or <see cref="T:System.IO.Compression.ZLibStream" />.</summary>
16+
<summary>Defines the compression algorithms that can be used for <see cref="T:System.IO.Compression.DeflateStream" />, <see cref="T:System.IO.Compression.GZipStream" />, and <see cref="T:System.IO.Compression.ZLibStream" />.</summary>
1717
<remarks>To be added.</remarks>
1818
</Docs>
1919
<Members>
@@ -55,7 +55,7 @@
5555
<MemberValue>1</MemberValue>
5656
<Docs>
5757
<summary>
58-
<para>Used for data produced by a filter (or predictor). The effect of Filtered is to force more Huffman coding and less string matching, intermediate between Default and HuffmanOnly.</para>
58+
<para>Used for data produced by a filter (or predictor). The effect of Filtered is to force more Huffman coding and less string matching; it's an intermediate between Default and HuffmanOnly.</para>
5959
</summary>
6060
</Docs>
6161
</Member>
@@ -116,7 +116,7 @@
116116
</ReturnValue>
117117
<MemberValue>3</MemberValue>
118118
<Docs>
119-
<summary>Used to limit match distances to one (run-length encoding), give better compression for PNG image data.</summary>
119+
<summary>Used to limit match distances to one (run-length encoding). Gives better compression for PNG image data.</summary>
120120
</Docs>
121121
</Member>
122122
</Members>

xml/System.IO.Compression/ZLibStream.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@
162162
<param name="compressionOptions">The ZLib options for fine tuning the compression stream.</param>
163163
<param name="leaveOpen">
164164
<see langword="true" /> to leave the stream object open after disposing the <see cref="T:System.IO.Compression.ZLibStream" /> object; otherwise, <see langword="false" />.</param>
165-
<summary>Initializes a new instance of the <see cref="T:System.IO.Compression.ZLibStream" /> class by using the specified stream, compression options, and optionally leaves the stream open.</summary>
165+
<summary>Initializes a new instance of the <see cref="T:System.IO.Compression.ZLibStream" /> class by using the specified stream and compression options, and optionally leaves the stream open.</summary>
166166
<remarks>To be added.</remarks>
167167
<exception cref="T:System.ArgumentNullException">
168168
<paramref name="stream" /> or <paramref name="compressionOptions" /> is <see langword="null" />.</exception>

0 commit comments

Comments
 (0)