From 7b23b3212aaa87b3752d3818febf3b10cfacb798 Mon Sep 17 00:00:00 2001
From: Chris Hennick <hennickc@amazon.com>
Date: Thu, 1 Jun 2023 12:56:11 -0700
Subject: [PATCH] Update doc comment about `compression_method`
---
src/write.rs | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/src/write.rs b/src/write.rs
index 8af8427e..67200c9f 100644
--- a/src/write.rs
+++ b/src/write.rs
@@ -231,8 +231,10 @@ impl arbitrary::Arbitrary<'_> for FileOptions {
impl FileOptions {
/// Set the compression method for the new file
///
- /// The default is `CompressionMethod::Deflated`. If the deflate compression feature is
- /// disabled, `CompressionMethod::Stored` becomes the default.
+ /// The default is `CompressionMethod::Deflated` if it is enabled. If not,
+ /// `CompressionMethod::Bzip2` is the default if it is enabled. If neither `bzip2` nor `deflate`
+ /// is enabled, `CompressionMethod::Zlib` is the default. If all else fails,
+ /// `CompressionMethod::Stored` becomes the default and files are written uncompressed.
#[must_use]
pub fn compression_method(mut self, method: CompressionMethod) -> FileOptions {
self.compression_method = method;