From fbd9ff95bdd9c9bd904d87f2b2f2d88470c68173 Mon Sep 17 00:00:00 2001
From: Jasper Van der Jeugt <jaspervdj@gmail.com>
Date: Sun, 31 Jan 2010 13:40:15 +0100
Subject: A little more documentation.

---
 src/Text/Hakyll/File.hs | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'src/Text/Hakyll')

diff --git a/src/Text/Hakyll/File.hs b/src/Text/Hakyll/File.hs
index a7ed7b3..649f2a3 100644
--- a/src/Text/Hakyll/File.hs
+++ b/src/Text/Hakyll/File.hs
@@ -45,7 +45,9 @@ toCache :: FilePath -> Hakyll FilePath
 toCache path = do dir <- askHakyll cacheDirectory
                   return $ dir </> removeLeadingSeparator path
 
--- | Get the url for a given page.
+-- | Get the url for a given page. For most extensions, this would be the path
+--   itself. It's only for rendered extensions (@.markdown@, @.rst@, @.lhs@ this
+--   function returns a path with a @.html@ extension instead.
 toUrl :: FilePath -> FilePath
 toUrl path = if takeExtension path `elem` [ ".markdown"
                                           , ".md"
-- 
cgit v1.2.3