Skip to content

Commit 56fbdc5

Browse files
authored
Clarify doc comment to make it a bit less scary
1 parent 5c0a63c commit 56fbdc5

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/common.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -329,8 +329,8 @@ pub enum Compression {
329329
/// Extremely fast but light compression.
330330
///
331331
/// Note: When used in streaming mode, this compression level can actually result in files
332-
/// *larger* than would be produced by `NoCompression` because it doesn't do any buffering of
333-
/// the output stream to detect whether the data is being compressed or not.
332+
/// *larger* than would be produced by `NoCompression` on incompressible data because
333+
/// it doesn't do any buffering of the output stream to detect whether the data is being compressed or not.
334334
Fastest,
335335
/// Extremely fast compression with a decent compression ratio.
336336
///
@@ -339,7 +339,7 @@ pub enum Compression {
339339
/// better compression ratio than the fastest modes of other encoders.
340340
///
341341
/// Like `Compression::Fast` this can currently produce files larger than `NoCompression` in
342-
/// streaming mode. This may change in the future.
342+
/// streaming mode when given incompressible data. This may change in the future.
343343
Fast,
344344
/// Balances encoding speed and compression ratio
345345
Balanced,

0 commit comments

Comments
 (0)