From e28ccb328f1edbcd071bf5990f6d824d479646bc Mon Sep 17 00:00:00 2001
From: Tau <git@tau.garden>
Date: Wed, 17 Jan 2024 18:45:44 +0100
Subject: [PATCH] Improve error docs

---
 src/lib.rs | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/lib.rs b/src/lib.rs
index fcde7cd..0b481f2 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -72,7 +72,9 @@ pub enum Error {
     /// The terminal responded using an unsupported response format.
     #[error("failed to parse response {0:?}")]
     Parse(String),
-    /// The query timed out.
+    /// The query timed out. This can happen because \
+    /// either the terminal does not support querying for colors \
+    /// or the terminal has a lot of latency (e.g. when connected via SSH).
     #[error("operation did not complete within {0:?}")]
     Timeout(Duration),
     /// The terminal is known to be unsupported.