]> gitweb.michael.orlitzky.com - dead/htsn-import.git/commitdiff
Update docs in TSN.XML.Injuries.
authorMichael Orlitzky <michael@orlitzky.com>
Tue, 21 Jan 2014 19:05:43 +0000 (14:05 -0500)
committerMichael Orlitzky <michael@orlitzky.com>
Tue, 21 Jan 2014 19:05:43 +0000 (14:05 -0500)
src/TSN/XML/Injuries.hs

index 6cc802f9752d2dcbc13d59e3415cd38f7d9fb963..eb369e03eb8d1ecae646a383a4d0a95e9e2b8659 100644 (file)
@@ -82,7 +82,7 @@ data InjuriesTeam =
 
 -- * InjuriesListing/InjuriesListingXml
 
--- | XML/Database representation of the injury listings.
+-- | XML representation of the injury listings.
 --
 data InjuriesListingXml =
   InjuriesListingXml {
@@ -122,6 +122,9 @@ instance FromXmlFk InjuriesListingXml where
       db_injuries = xml_injuries,
       db_updated = xml_updated }
 
+-- | This allows us to insert the XML representation
+--   'InjuriesListingXml' directly.
+--
 instance XmlImportFk InjuriesListingXml
 
 
@@ -139,8 +142,7 @@ data Message =
     xml_time_stamp :: UTCTime }
   deriving (Eq, Show)
 
--- | Database representation of a 'Message'. We really only care about
---   the time stamp.
+-- | Database representation of a 'Message'.
 --
 data Injuries =
   Injuries {
@@ -162,6 +164,9 @@ instance FromXml Message where
       db_sport = xml_sport,
       db_time_stamp = xml_time_stamp }
 
+-- | This allows us to insert the XML representation 'Message'
+--   directly.
+--
 instance XmlImport Message
 
 
@@ -175,7 +180,8 @@ instance DbImport Message where
       migrate (undefined :: Injuries)
       migrate (undefined :: InjuriesListing)
 
-  -- | We import a 'Message' by inserting all of its 'listings'.
+  -- | We import a 'Message' by inserting all of its 'listings', but
+  --   the listings require a foreign key to the parent 'Message'.
   --
   dbimport msg = do
     msg_id <- insert_xml msg