Move FeedHosts under the TSN namespace.

[dead/htsn.git] / src / TSN / FeedHosts.hs

diff --git a/src/FeedHosts.hs b/src/TSN/FeedHosts.hs
similarity index 61%
rename from src/FeedHosts.hs
rename to src/TSN/FeedHosts.hs
index 43bab176aa67efeaba8e6a045aa1ae9d8057481d..0b2056ec3ee983587b2ed74133ebfebc15fa6bdd 100644 (file)
--- a/src/FeedHosts.hs
+++ b/src/TSN/FeedHosts.hs
@@ -1,10 +1,14 @@
 {-# LANGUAGE DeriveDataTypeable #-}
 
 -- | A newtype around a list of Strings which represent the feed
--- hosts. This is all to avoid an orphan instance of Configured for
--- [String] if we had defined one in e.g. OptionalConfiguration.
+--   hosts. This is all to avoid an orphan instance of Configured for
+--   [String] if we had defined one in e.g. OptionalConfiguration.
 --
-module FeedHosts
+--   This was placed under the "TSN" namespace because its Default
+--   instance is specific to TSN, even though otherwise it's just a
+--   list of strings.
+--
+module TSN.FeedHosts
 where
 
 -- DC is needed only for the DCT.Configured instance of String.
@@ -19,8 +23,11 @@ newtype FeedHosts =
   FeedHosts { get_feed_hosts :: [String] }
     deriving (Data, Show, Typeable)
 
-
 instance Default FeedHosts where
+  -- | The default list of feed hosts. These were found by checking
+  --   PTR records in the neighborhood of the IP address in use. There
+  --   is a feed4.sportsnetwork.com, but it was not operational when
+  --   this was written.
   def = FeedHosts ["feed1.sportsnetwork.com",
                    "feed2.sportsnetwork.com",
                    "feed3.sportsnetwork.com"]