Un-haddock two comments that wound up in the wrong place due to template haskell.

[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..6e10aed9d166089d7119b543066340a28596f717 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(..),
@@ -226,9 +227,9 @@ instance DbImport Message where
     return ImportSucceeded
 
 
--- | These types don't have special XML representations or field name
---   collisions so we use the defaultCodegenConfig and give their
---   fields nice simple names.
+-- These types don't have special XML representations or field name
+-- collisions so we use the defaultCodegenConfig and give their
+-- fields nice simple names.
 mkPersist defaultCodegenConfig [groundhog|
 - entity: NewsTeam
   dbName: news_teams
@@ -251,9 +252,8 @@ mkPersist defaultCodegenConfig [groundhog|
 |]
 
 
--- | These types have fields with e.g. db_ and xml_ prefixes, so we
---   use our own codegen to peel those off before naming the columns.
---
+-- These types have fields with e.g. db_ and xml_ prefixes, so we
+-- use our own codegen to peel those off before naming the columns.
 mkPersist tsn_codegen_config [groundhog|
 - entity: News
   dbName: news
@@ -387,8 +387,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 +402,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 +425,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 +442,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"