@@ -17,7 +17,7 @@ import Data.Text (Text)
17import Text.Inflections.Types
17import Text.Inflections.Types
18import qualified Data.Text as T
18import qualified Data.Text as T
20−-- | Capitalize all the Words in the input list.
20+-- | Capitalize all the 'SomeWord' words in the input list.
22-- >>> foo <- SomeWord <$> mkWord "foo"
22-- >>> foo <- SomeWord <$> mkWord "foo"
23-- >>> bar <- SomeWord <$> mkAcronym "bar"
23-- >>> bar <- SomeWord <$> mkAcronym "bar"
@@ -25,6 +25,6 @@ import qualified Data.Text as T
25-- >>> titleize [foo,bar,bazz]
25-- >>> titleize [foo,bar,bazz]
26-- "Foo bar Bazz"
26-- "Foo bar Bazz"
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
29 -> Text -- ^ The titleized 'Text'
29 -> Text -- ^ The titleized 'Text'
30titleize = T.unwords . fmap (unSomeWord T.toTitle)
30titleize = T.unwords . fmap (unSomeWord T.toTitle)