X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=src%2FTSN%2FXML%2FHeartbeat.hs;h=a3a169347385b3197f018af5d914c4b1c5a6e266;hb=bd75961380ef07c2ba0ab5412e4326a197fd40c5;hp=588c75c6a54006f14dc1185bc18ac7f3f7087f7c;hpb=4cdcdbe593c30f6434a25896951a1a4dfcc2b1ca;p=dead%2Fhtsn-import.git

diff --git a/src/TSN/XML/Heartbeat.hs b/src/TSN/XML/Heartbeat.hs
index 588c75c..a3a1693 100644
--- a/src/TSN/XML/Heartbeat.hs
+++ b/src/TSN/XML/Heartbeat.hs
@@ -3,8 +3,9 @@
 -- | Handle documents defined by Heartbeat.dtd.
 --
 module TSN.XML.Heartbeat (
-  heartbeat_tests,
-  verify )
+  verify,
+  -- * Tests
+  heartbeat_tests )
 where
 
 -- System imports.
@@ -14,7 +15,6 @@ import Test.Tasty.HUnit ( (@?=), testCase )
 import Text.XML.HXT.Core (
   PU,
   unpickleDoc,
-  XmlPickler(..),
   XmlTree,
   xpTriple,
   xpElem,
@@ -29,6 +29,7 @@ import Xml ( pickle_unpickle, unpickleable )
 
 -- | The data structure that holds the XML representation of a
 --   Heartbeat message.
+--
 data Message =
   Message {
     xml_file_id :: Int,
@@ -39,6 +40,7 @@ data Message =
 
 -- | A (un)pickler that turns a Heartbeat XML file into a 'Message'
 --   and vice-versa.
+--
 pickle_message :: PU Message
 pickle_message =
   xpElem "message" $
@@ -64,8 +66,12 @@ verify xml = do
     Nothing -> ImportFailed "Could not unpickle document in import_generic."
     Just _  -> ImportSkipped "Heartbeat received. Thump."
 
+--
+-- Tasty Tests
+--
 
--- * Tasty Tests
+-- | A list of all tests for this module.
+--
 heartbeat_tests :: TestTree
 heartbeat_tests =
   testGroup
@@ -74,8 +80,9 @@ heartbeat_tests =
       test_unpickle_succeeds ]
 
 
--- | Warning: succeess of this test does not mean that unpickling
---   succeeded.
+-- | If we unpickle something and then pickle it, we should wind up
+--   with the same thing we started with. WARNING: success of this
+--   test does not mean that unpickling succeeded.
 --
 test_pickle_of_unpickle_is_identity :: TestTree
 test_pickle_of_unpickle_is_identity =