From 8dc6823e988b8828454f6ef1ea2b43e3e0cc5a20 Mon Sep 17 00:00:00 2001
From: Thomas Hochstein <thh@inter.net>
Date: Tue, 3 Sep 2013 17:12:09 +0200
Subject: [PATCH] Small comment fixes.

Signed-off-by: Thomas Hochstein <thh@inter.net>
---
 bin/gatherstats.pl |  2 ++
 lib/NewsStats.pm   | 16 +++++++---------
 2 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/bin/gatherstats.pl b/bin/gatherstats.pl
index 6096417..a5a486a 100755
--- a/bin/gatherstats.pl
+++ b/bin/gatherstats.pl
@@ -73,6 +73,8 @@ $OptStatsType = 'all' if !$OptStatsType;
 ### get time period from --month
 # get verbal description of time period, drop SQL code
 my ($Period) = &GetTimePeriod($OptMonth);
+# bail out if --month is invalid or set to 'ALL';
+# we don't support the latter
 &Bleat(2,"--month option has an invalid format - please use 'YYYY-MM' or ".
          "'YYYY-MM:YYYY-MM'!") if (!$Period or $Period eq 'all time');
 
diff --git a/lib/NewsStats.pm b/lib/NewsStats.pm
index 8a62179..a3676d0 100644
--- a/lib/NewsStats.pm
+++ b/lib/NewsStats.pm
@@ -4,7 +4,7 @@
 #
 # Copyright (c) 2010-2013 Thomas Hochstein <thh@inter.net>
 #
-# This module can be redistributed and/or modified under the same terms under 
+# This module can be redistributed and/or modified under the same terms under
 # which Perl itself is published.
 
 package NewsStats;
@@ -244,7 +244,7 @@ sub ReadGroupList {
 ### ignoring everything after the first whitespace and so accepting files
 ### in checkgroups format as well as (parts of) an INN active file)
 ### IN : $Filename    : file to read
-### OUT: \%ValidGroups: hash containing all valid newsgroups
+### OUT: \%ValidGroups: reference to a hash containing all valid newsgroups
   my ($Filename) = @_;
   my %ValidGroups;
   open (my $LIST,"<$Filename") or &Bleat(2,"Cannot read $Filename: $!");
@@ -275,12 +275,12 @@ sub GetTimePeriod {
   my ($Verbal, $SQL);
   # define a regular expression for a month
   my $REMonth = '\d{4}-\d{2}';
-  
+
   # default to last month if option is not set
   if(!$Month) {
     $Month = &LastMonth;
   }
-  
+
   # check for valid input
   if ($Month =~ /^$REMonth$/) {
     # single month (YYYY-MM)
@@ -299,7 +299,7 @@ sub GetTimePeriod {
     # invalid input
     return (undef,undef);
   }
-  
+
   return ($Verbal,$SQL);
 };
 
@@ -407,7 +407,7 @@ sub OutputData {
   my %ValidKeys = %{$ValidKeys} if $ValidKeys;
   my ($FileName, $Handle, $OUT);
   our $LastIteration;
-  
+
   # define output types
   my %LegalOutput;
   @LegalOutput{('dump','list','pretty')} = ();
@@ -439,7 +439,7 @@ sub OutputData {
       # safeguards for filename creation:
       # replace potential problem characters with '_'
       $FileName = sprintf('%s-%s',$FileTempl,$Caption);
-      $FileName =~ s/[^a-zA-Z0-9_-]+/_/g; 
+      $FileName =~ s/[^a-zA-Z0-9_-]+/_/g;
       open ($OUT,">$FileName")
         or &Bleat(2,sprintf("Cannot open output file '%s': $!",
                             $FileName));
@@ -776,5 +776,3 @@ sub CheckValidNewsgroups {
 
 #####------------------------------- done ---------------------------------#####
 1;
-
-