summaryrefslogtreecommitdiff
path: root/wttrin.el
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-04-04 14:07:29 -0500
committerCraig Jennings <c@cjennings.net>2026-04-04 14:07:29 -0500
commit583ba34888e1c82da1f2bffbc913477c2e6a6df6 (patch)
tree2f5f245a3494c592904eb3c08e96fd56e2e67730 /wttrin.el
parentfaddcefa98c41356d8fd66d561f1e45453b19d05 (diff)
downloademacs-wttrin-583ba34888e1c82da1f2bffbc913477c2e6a6df6.tar.gz
emacs-wttrin-583ba34888e1c82da1f2bffbc913477c2e6a6df6.zip
doc: note wttr.in update frequency in refresh interval docstrings
wttr.in updates its data roughly every 10 minutes (max-age=600). Add a note to both refresh interval defcustoms so users know not to poll more aggressively than the service can provide.
Diffstat (limited to 'wttrin.el')
-rw-r--r--wttrin.el7
1 files changed, 5 insertions, 2 deletions
diff --git a/wttrin.el b/wttrin.el
index 1d60d65..982e0a0 100644
--- a/wttrin.el
+++ b/wttrin.el
@@ -97,7 +97,8 @@ units (default)."
"Interval in seconds between proactive weather data refreshes.
Controls how often the background timer refreshes cached weather data
for `wttrin-favorite-location'. Data older than 2x this interval
-is considered stale."
+is considered stale. The wttr.in service updates roughly every 10
+minutes, so values below 600 just waste their bandwidth."
:group 'wttrin
:type 'integer)
@@ -126,7 +127,9 @@ The weather icon and tooltip will update automatically in the background."
(defcustom wttrin-mode-line-refresh-interval 3600
"Interval in seconds to refresh mode-line weather data.
-Default is 3600 seconds (1 hour)."
+Default is 3600 seconds (1 hour). The wttr.in service updates its
+data roughly every 10 minutes; polling more often than that just
+wastes their bandwidth. Be kind to the free service."
:group 'wttrin
:type 'integer)