@@ -17,7 +17,7 @@ import Data.Text (Text)
1717import Text.Inflections.Types
1818import qualified Data.Text as T
1919
20−-- | Capitalize all the Words in the input list.
20+-- | Capitalize all the 'SomeWord' words in the input list.
2121--
2222-- >>> foo <- SomeWord <$> mkWord "foo"
2323-- >>> bar <- SomeWord <$> mkAcronym "bar"
@@ -25,6 +25,6 @@ import qualified Data.Text as T
2525-- >>> titleize [foo,bar,bazz]
2626-- "Foo bar Bazz"
2727titleize
28− :: [SomeWord] -- ^ List of words, first of which will be capitalized
28+ :: [SomeWord] -- ^ List of words, of which all 'SomeWord' words will be capitalized and all acronyms will be left as is
2929 -> Text -- ^ The titleized 'Text'
3030titleize = T.unwords . fmap (unSomeWord T.toTitle)