Finish the documentation for ScheduleChanges.

[dead/htsn-import.git] / src / TSN / Team.hs

diff --git a/src/TSN/Team.hs b/src/TSN/Team.hs
index 910c67120da44aa0b621f1bf3db87315c94694a2..36d58ca44f7747732ea9782818828aa7cd097777 100644 (file)
--- a/src/TSN/Team.hs
+++ b/src/TSN/Team.hs
@@ -28,15 +28,17 @@ import Database.Groundhog.TH (
 
 -- | The database representation of a team. The 'team_id' is a
 --   'String' field because some teams do in fact have ids like
---   \"B52\".
+--   \"B52\". The pointless \"team_\" prefix is left on the 'team_id'
+--   field because otherwise the auto-generated column name would
+--   conflict with the default \"id\" primary key.
 --
 data Team =
   Team {
     team_id :: String, -- ^ Some of them contain characters
-    team_abbreviation :: Maybe String, -- ^ Some teams don't have abbreviations,
-                                       --   or at least, some sample jfilexml
-                                       --   don't have them for some teams.
-    team_name :: Maybe String -- ^ Some teams don't even have names!
+    abbreviation :: Maybe String, -- ^ Some teams don't have abbreviations,
+                                  --   or at least, some sample jfilexml
+                                  --   don't have them for some teams.
+    name :: Maybe String -- ^ Some teams don't even have names!
     }
   deriving (Eq, Show)