From 99c57706a965c1c1c93f3a02a2578fea2ed3ab81 Mon Sep 17 00:00:00 2001
From: Richard Cook <rcook@rcook.org>
Date: Fri, 21 Jul 2017 20:45:46 -0600
Subject: [PATCH] Fixes #45: Update doc comment for titleize to indicate that
 it capitalizes all words

---
 Text/Inflections/Titleize.hs | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Text/Inflections/Titleize.hs b/Text/Inflections/Titleize.hs
index 0d9c0ef..31dba40 100644
--- a/Text/Inflections/Titleize.hs
+++ b/Text/Inflections/Titleize.hs
@@ -17,7 +17,7 @@ import Data.Text (Text)
 import Text.Inflections.Types
 import qualified Data.Text as T
 
--- | Capitalize all the Words in the input list.
+-- | Capitalize all the 'SomeWord' words in the input list.
 --
 -- >>> foo  <- SomeWord <$> mkWord "foo"
 -- >>> bar  <- SomeWord <$> mkAcronym "bar"
@@ -25,6 +25,6 @@ import qualified Data.Text as T
 -- >>> titleize [foo,bar,bazz]
 -- "Foo bar Bazz"
 titleize
-  :: [SomeWord] -- ^ List of words, first of which will be capitalized
+  :: [SomeWord] -- ^ List of words, of which all 'SomeWord' words will be capitalized and all acronyms will be left as is
   -> Text       -- ^ The titleized 'Text'
 titleize = T.unwords . fmap (unSomeWord T.toTitle)