From 3fc46ef0ad3cd6ba004e56f0a607293d8ba5ddea Mon Sep 17 00:00:00 2001
From: Frank Elsinga <frank@elsinga.de>
Date: Sun, 15 Dec 2024 20:05:14 +0100
Subject: [PATCH] documented the defaults for `Options`

---
 src/options.rs | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/src/options.rs b/src/options.rs
index 152737b3..f2cf7c51 100644
--- a/src/options.rs
+++ b/src/options.rs
@@ -97,13 +97,16 @@ pub struct Options {
     pub filter: IndexSet<RowFilter>,
     /// Whether to change the interlacing type of the file.
     ///
-    /// `None` will not change the current interlacing type.
-    ///
-    /// `Some(x)` will change the file to interlacing mode `x`.
+    /// These are the interlacing types avaliable:
+    /// - `None` will not change the current interlacing type.
+    /// - `Some(x)` will change the file to interlacing mode `x`.
+    ///   See [`Interlacing`] for the possible interlacing types.
     ///
     /// Default: `Some(Interlacing::None)`
     pub interlace: Option<Interlacing>,
     /// Whether to allow transparent pixels to be altered to improve compression.
+    ///
+    /// Default: `false`
     pub optimize_alpha: bool,
     /// Whether to attempt bit depth reduction
     ///
@@ -145,9 +148,10 @@ pub struct Options {
     ///
     /// Default: `true`
     pub fast_evaluation: bool,
-
     /// Maximum amount of time to spend on optimizations.
     /// Further potential optimizations are skipped if the timeout is exceeded.
+    ///
+    /// Default: `None`
     pub timeout: Option<Duration>,
 }