# HG changeset patch
# User Matti Hamalainen <ccr@tnsp.org>
# Date 1401820697 -10800
# Node ID 4abb7a940e24e2534c696fb5f31bca31f5f84a38
# Parent  24f9f38210fe7e9ce6fc13924535b280512bde83
weather: Add comments.

diff -r 24f9f38210fe -r 4abb7a940e24 weather.tcl
--- a/weather.tcl	Tue Jun 03 21:37:59 2014 +0300
+++ b/weather.tcl	Tue Jun 03 21:38:17 2014 +0300
@@ -3,21 +3,30 @@
 # Weather v0.1 by Matti 'ccr' Hamalainen <ccr@tnsp.org>
 # (C) Copyright 2014 Tecnic Software productions (TNSP)
 #
-# Requires get_weather.tcl to be run as a cronjob, for example
-# 15 * * * *     /absolute/path/to/get_weather.tcl
+# Requires data fetcher to be run as a cronjob, see fetch_weather.pl
+# for more information.
 #
 # This script is freely distributable under GNU GPL (version 2) license.
 #
 ##########################################################################
 
+# Default location if none given and none set by user.
+# Multiple can be specified as "foo;bar;etc"
 set weather_default_locations "raahe"
 
+# Weather data file, must match the one in fetch_weather.pl's config
 set weather_datafile "/home/niinuska/bot/weather.data"
+
+# Alias data file
 set weather_aliasfile "/home/niinuska/bot/weather.alias"
+
+# How often to check the weather data file for updates (in minutes)
 set weather_check_period 2
 
+# Max number of results to be listed
 set weather_max_results 3
 
+# ...
 set weather_logmsg 1
 set weather_preferredmsg "PRIVMSG"