Merge pull request #46 from rcook/rcook-fix-typo

Fixes #45: Update doc comment for titleize to indicate that it capitalizes all words
This commit is contained in:
Juan Paucar 2017-07-21 22:33:21 -05:00 committed by GitHub
commit f103a07970

View File

@ -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)