Update (or add) a bunch of documentation.

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

diff --git a/src/TSN/XML/InjuriesDetail.hs b/src/TSN/XML/InjuriesDetail.hs
index 171b879a79726aff861cd6a3744f9b9ed95a4ded..38e0268a4e1d518cf6d00c1d0fed2d8f8c8661d0 100644 (file)
--- a/src/TSN/XML/InjuriesDetail.hs
+++ b/src/TSN/XML/InjuriesDetail.hs
@@ -17,8 +17,9 @@
 --   are not retained.
 --
 module TSN.XML.InjuriesDetail (
-  injuries_detail_tests,
   pickle_message,
+  -- * Tests
+  injuries_detail_tests,
   -- * WARNING: these are private but exported to silence warnings
   PlayerListingConstructor(..) )
 where
@@ -171,8 +172,12 @@ pickle_message =
                   listings m,
                   time_stamp m)
 
+--
+-- Tasty Tests
+--
 
--- * Tasty Tests
+-- | A list of all tests for this module.
+--
 injuries_detail_tests :: TestTree
 injuries_detail_tests =
   testGroup
@@ -181,8 +186,10 @@ injuries_detail_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: succeess of this
+--   test does not mean that unpickling succeeded.
+--
 test_pickle_of_unpickle_is_identity :: TestTree
 test_pickle_of_unpickle_is_identity = testGroup "pickle-unpickle tests"
   [ check "pickle composed with unpickle is the identity"
@@ -196,6 +203,8 @@ test_pickle_of_unpickle_is_identity = testGroup "pickle-unpickle tests"
       actual @?= expected
 
 
+-- | Make sure we can actually unpickle these things.
+--
 test_unpickle_succeeds :: TestTree
 test_unpickle_succeeds = testGroup "unpickle tests"
   [ check "unpickling succeeds"