Update (or add) a bunch of documentation.

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

diff --git a/src/TSN/XML/News.hs b/src/TSN/XML/News.hs
index b9bc3df4f84b98c58f369085868987d9cbecdbe3..7d8ef754a0081a16679200b4c2c4fd2869f28d21 100644 (file)
--- a/src/TSN/XML/News.hs
+++ b/src/TSN/XML/News.hs
@@ -11,8 +11,9 @@
 --   root element \<message\> that contains an entire news item.
 --
 module TSN.XML.News (
-  news_tests,
   pickle_message,
+  -- * Tests
+  news_tests,
   -- * WARNING: these are private but exported to silence warnings
   News_NewsLocationConstructor(..),
   News_NewsTeamConstructor(..),
@@ -387,8 +388,12 @@ pickle_message =
         to_string = join "\n"
 
 
+--
+-- Tasty Tests
+--
 
--- * Tasty Tests
+-- | A list of all tests for this module.
+--
 news_tests :: TestTree
 news_tests =
   testGroup
@@ -398,6 +403,8 @@ news_tests =
       test_unpickle_succeeds ]
 
 
+-- | Make sure our codegen is producing the correct database names.
+--
 test_news_fields_have_correct_names :: TestTree
 test_news_fields_have_correct_names =
   testCase "news fields get correct database names" $
@@ -419,8 +426,10 @@ test_news_fields_have_correct_names =
     check (x,y) = (x @?= y)
 
 
--- | 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"
@@ -434,6 +443,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"