From f508aac0cd7e8e04bd9f08aec37fccbf6767ac1b Mon Sep 17 00:00:00 2001
From: Marli Frost <marli@frost.red>
Date: Wed, 19 Aug 2020 12:20:43 +0100
Subject: [PATCH] docs: elaborate on usage of CompressionMethod

---
 src/compression.rs | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/src/compression.rs b/src/compression.rs
index 5888fe7c..3183e851 100644
--- a/src/compression.rs
+++ b/src/compression.rs
@@ -3,19 +3,25 @@
 use std::fmt;
 
 #[allow(deprecated)]
-/// Compression methods for the contents of a ZIP file.
+/// Identifies the storage format used to compress a file within a ZIP archive.
+///
+/// Each file's compression method is stored alongside it, allowing the
+/// contents to be read without context.
+///
+/// When creating ZIP files, you may choose the method to use with
+/// [`zip::write::FileOptions::compression_method`]
 #[derive(Copy, Clone, PartialEq, Debug)]
 pub enum CompressionMethod {
-    /// The file is stored (no compression)
+    /// Store the file as is
     Stored,
-    /// Deflate using any flate2 backend
+    /// Compress the file using Deflate
     #[cfg(any(
         feature = "deflate",
         feature = "deflate-miniz",
         feature = "deflate-zlib"
     ))]
     Deflated,
-    /// File is compressed using BZIP2 algorithm
+    /// Compress the file using BZIP2
     #[cfg(feature = "bzip2")]
     Bzip2,
     /// Unsupported compression method