summaryrefslogtreecommitdiff
path: root/src/Text/Hakyll/Util.hs
diff options
context:
space:
mode:
Diffstat (limited to 'src/Text/Hakyll/Util.hs')
-rw-r--r--src/Text/Hakyll/Util.hs5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/Text/Hakyll/Util.hs b/src/Text/Hakyll/Util.hs
index 5105a31..358c60e 100644
--- a/src/Text/Hakyll/Util.hs
+++ b/src/Text/Hakyll/Util.hs
@@ -1,3 +1,4 @@
+-- | Miscellaneous text manipulation functions.
module Text.Hakyll.Util
( trim
, stripHTML
@@ -26,6 +27,8 @@ stripHTML str = let (beforeTag, rest) = break (== '<') str
-- | Make a HTML link.
--
-- > link "foo" "bar.html" == "<a href='bar.html'>foo</a>"
-link :: String -> String -> String
+link :: String -- ^ Link text.
+ -> String -- ^ Link destination.
+ -> String
link text destination = "<a href=\"" ++ destination ++ "\">"
++ text ++ "</a>"