Clean up a bunch of code and comments.

[dead/halcyon.git] / src / StringUtils.hs

diff --git a/src/StringUtils.hs b/src/StringUtils.hs
index a9e2625289c65be857d068f35a850e32009369ae..e498c2eea81cfc2025e2f3c546ecd519c0678832 100644 (file)
--- a/src/StringUtils.hs
+++ b/src/StringUtils.hs
@@ -7,12 +7,13 @@ where
 import Test.Tasty ( TestTree, testGroup )
 import Test.Tasty.HUnit ( (@?=), testCase )
 
--- | Takes a list of strings, call them string1, string2, etc. and
---   numbers them like a list. So,
+
+-- | Takes a list of strings and numbers it like an ordered list.
+--
+--   Examples:
 --
---   1. string1
---   2. string2
---   3. etc.
+--   >>> listify ["foo", "bar", "baz"]
+--   ["1. foo","2. bar","3. baz"]
 --
 listify :: [String] -> [String]
 listify =
@@ -23,7 +24,7 @@ listify =
 
 
 --
--- Tests
+-- * Tests
 --
 
 string_utils_tests :: TestTree