Add some docs for AutoRacingResults, and fix others.

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

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 =