Add some docs for AutoRacingResults, and fix others.

diff --git a/src/TSN/Picklers.hs b/src/TSN/Picklers.hs
index bc13badbd7134691fe6ee4158019f3b926cbc41b..be4caa64c382b2dd5a995677e2fd1a3f549e59af 100644 (file)
--- a/src/TSN/Picklers.hs
+++ b/src/TSN/Picklers.hs
@@ -35,8 +35,9 @@ import TSN.Parse (
 -- | The format string for a base date in m/d/yyyy format. The
 --   day/month are not padded at all. This will match for example,
 --
---   * 2/15/1983
---   * 1/1/0000
+--   * 2\/15\/1983
+--
+--   * 1\/1\/0000
 --
 date_format :: String
 date_format = "%-m/%-d/%Y"
@@ -46,8 +47,9 @@ date_format = "%-m/%-d/%Y"
 --   day/month are padded to two characters with zeros. This will
 --   match for example,
 --
---   * 02/15/1983
---   * 01/01/0000
+--   * 02\/15\/1983
+--
+--   * 01\/01\/0000
 --
 date_format_padded :: String
 date_format_padded = "%0m/%0d/%Y"
@@ -108,9 +110,11 @@ format_commas x =
 -- | Parse \<Earnings\> from an 'AutoRaceResultsListing'. These are
 --   essentially 'Int's, but they look like,
 --
---   * <Earnings>336,826</Earnings>
---   * <Earnings>1,000,191</Earnings>
---   * <Earnings>TBA</Earnings>
+--   * \<Earnings\>336,826\</Earnings\>
+--
+--   * \<Earnings\>1,000,191\</Earnings\>
+--
+--   * \<Earnings\>TBA\</Earnings\>
 --
 xp_earnings :: PU (Maybe Int)
 xp_earnings =
@@ -132,10 +136,11 @@ xp_earnings =
 -- | (Un)pickle a 'UTCTime' from a \<RaceDate\> element in an
 --   'AutoRaceResults' message.
 --
---   Example:
+--   Examples:
+--
+--   * \<RaceDate\>6/1/2014 1:00:00 PM\</RaceDate\>
 --
---   <RaceDate>6/1/2014 1:00:00 PM</RaceDate>
---   <RaceDate>5/24/2014 2:45:00 PM</RaceDate>
+--   * \<RaceDate\>5/24/2014 2:45:00 PM\</RaceDate\>
 --
 xp_racedate :: PU UTCTime
 xp_racedate =

diff --git a/src/TSN/XML/AutoRacingResults.hs b/src/TSN/XML/AutoRacingResults.hs
index 596b0bd46c4d7fff742a444f304ef3a7ec462360..96433ee0e7638efd31c257e61e812b12776c4970 100644 (file)
--- a/src/TSN/XML/AutoRacingResults.hs
+++ b/src/TSN/XML/AutoRacingResults.hs
@@ -82,7 +82,9 @@ dtd = "AutoRacingResultsXML.dtd"
 
 -- * AutoRacingResults/Message
 
--- | Database representation of a 'Message'.
+-- | Database representation of a 'Message'. Comparatively, it lacks
+--   the listings and race information since they are linked via a
+--   foreign key.
 --
 data AutoRacingResults =
   AutoRacingResults {
@@ -101,7 +103,9 @@ data AutoRacingResults =
 
 
 
--- | XML Representation of an 'AutoRacingResults'.
+-- | XML Representation of an 'AutoRacingResults'. It has the same
+--   fields, but in addition contains the 'xml_listings' and
+--   'xml_race_information'.
 --
 data Message =
   Message {
@@ -177,6 +181,7 @@ data AutoRacingResultsListing =
     db_nc :: Maybe Bool,
     db_earnings :: Maybe Int }
 
+
 -- | XML representation of a \<Listing\> contained within a
 --   \<message\>.
 --
@@ -204,6 +209,7 @@ instance ToDb AutoRacingResultsListingXml where
   --
   type Db AutoRacingResultsListingXml = AutoRacingResultsListing
 
+
 instance FromXmlFk AutoRacingResultsListingXml where
   -- | Each 'AutoRacingResultsListingXml' is contained in (i.e. has a
   --   foreign key to) a 'AutoRacingResults'.
@@ -396,8 +402,10 @@ mkPersist tsn_codegen_config [groundhog|
             onDelete: cascade
         - name: db_most_laps_leading
           embeddedType:
-            - {name: most_laps_leading_driver_id, dbName: most_laps_leading_driver_id}
-            - {name: most_laps_leading_driver, dbName: most_laps_leading_driver}
+            - {name: most_laps_leading_driver_id,
+               dbName: most_laps_leading_driver_id}
+            - {name: most_laps_leading_driver,
+               dbName: most_laps_leading_driver}
 
 - embedded: MostLapsLeading
   fields:
@@ -414,6 +422,8 @@ mkPersist tsn_codegen_config [groundhog|
 --- Pickling
 ---
 
+-- | Pickler for the \<Listing\>s contained within \<message\>s.
+--
 pickle_listing :: PU AutoRacingResultsListingXml
 pickle_listing =
   xpElem "Listing" $
@@ -449,6 +459,7 @@ pickle_listing =
 
 
 -- | Pickler for the top-level 'Message'.
+--
 pickle_message :: PU Message
 pickle_message =
   xpElem "message" $
@@ -483,6 +494,9 @@ pickle_message =
                   xml_time_stamp m)
 
 
+-- | Pickler for the \<Most_Laps_Leading\> child of a
+--   \<Race_Information\>.
+--
 pickle_most_laps_leading :: PU MostLapsLeading
 pickle_most_laps_leading =
   xpElem "Most_Laps_Leading" $
@@ -496,6 +510,9 @@ pickle_most_laps_leading =
                   db_most_laps_leading_driver m,
                   db_most_laps_leading_number_of_laps m)
 
+
+-- | Pickler for the \<Race_Information\> child of \<message\>.
+--
 pickle_race_information :: PU AutoRacingResultsRaceInformationXml
 pickle_race_information =
   xpElem "Race_Information" $

diff --git a/src/TSN/XML/AutoRacingSchedule.hs b/src/TSN/XML/AutoRacingSchedule.hs
index 1f459860244b33d0e5c7b6b1d907e074a40e200b..5a0344c91570b765cc46ea69bea63610fb1232bf 100644 (file)
--- a/src/TSN/XML/AutoRacingSchedule.hs
+++ b/src/TSN/XML/AutoRacingSchedule.hs
@@ -244,8 +244,7 @@ newtype AutoRacingScheduleListingRaceResult =
   deriving (Eq, Show)
 
 
--- * AutoRacingScheduleListingRaceResultRaceResultListing /
---   AutoRacingScheduleListingRaceResultRaceResultListingXml
+-- * AutoRacingScheduleListingRaceResultRaceResultListing / AutoRacingScheduleListingRaceResultRaceResultListingXml
 --
 --   Sorry about the names yo.
 --

diff --git a/src/TSN/XML/GameInfo.hs b/src/TSN/XML/GameInfo.hs
index 43c7cca7624325bf0b9c2b85e5f95abb36266e75..421d28693b6d0e7678432c9ccfdbc930db06013f 100644 (file)
--- a/src/TSN/XML/GameInfo.hs
+++ b/src/TSN/XML/GameInfo.hs
@@ -54,7 +54,7 @@ import Xml (
   unsafe_read_document )
 
 
--- | The DTDs for everything that we consider "Game Info."
+-- | The DTDs for everything that we consider \"Game Info.\"
 --
 --   TODO: This is the list from the old implementation. We need to
 --   make sure that we are really receiving XML for these DTDs

diff --git a/src/TSN/XML/Scores.hs b/src/TSN/XML/Scores.hs
index 571f6b383833da7c5edba1f146b25cb6fe7e15f0..ef2330c6060f01686d6c1499d265c73d1f6b6fab 100644 (file)
--- a/src/TSN/XML/Scores.hs
+++ b/src/TSN/XML/Scores.hs
@@ -253,13 +253,15 @@ newtype ScoreGameHTeam =
 -- * ScoreGame_ScoreGameTeam
 
 -- | Join a 'ScoreGame' with its home/away teams. Database-only. We
---   use a join table because the teams are kept unique.
+--   use a join table because the teams are kept unique. The first
+--   argument is the game id, the second argument is the visiting team
+--   (vteam) id, and the last argument is the home team (hteam) id.
 --
 data ScoreGame_ScoreGameTeam =
   ScoreGame_ScoreGameTeam
-    (DefaultKey ScoreGame) -- ^ game id
-    (DefaultKey ScoreGameTeam) -- ^ vteam id
-    (DefaultKey ScoreGameTeam) -- ^ hteam id
+    (DefaultKey ScoreGame) -- game id
+    (DefaultKey ScoreGameTeam) -- vteam id
+    (DefaultKey ScoreGameTeam) -- hteam id
 
 
 -- * ScoreLocation

diff --git a/src/TSN/XML/SportInfo.hs b/src/TSN/XML/SportInfo.hs
index 6dc1bbbc5fc22e402f4ab3fe69808b7c85e16775..d47f1c1ba88ef6ebd2be2c0659b8bdab9e7630ee 100644 (file)
--- a/src/TSN/XML/SportInfo.hs
+++ b/src/TSN/XML/SportInfo.hs
@@ -58,7 +58,7 @@ import Xml (
   unsafe_read_document )
 
 
--- | The DTDs for everything that we consider "Sport Info."
+-- | The DTDs for everything that we consider \"Sport Info.\"
 --
 --   TODO: This is the list from the old implementation. We need to
 --   make sure that we are really receiving XML for these DTDs