typeable/inflections-hs
1
0
Fork 0
mirror of https://github.com/typeable/inflections-hs.git synced 2024-08-15 17:10:21 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fixes #45: Update doc comment for titleize to indicate that it capitalizes all words

Browse Source
This commit is contained in:
Richard Cook 2017-07-21 20:45:46 -06:00
parent 8d7c0be1f7
commit 99c57706a9
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Text/Inflections/Titleize.hs
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)