reworded 'joinPath' comments

2011-09-11 17:47:21 -04:00 · 2011-09-11 17:47:21 -04:00 · bd617a846e
commit bd617a846e
parent 0c55024500
1 changed files with 3 additions and 2 deletions
--- a/yesod-core/Yesod/Internal/Core.hs
+++ b/yesod-core/Yesod/Internal/Core.hs
@ -205,8 +205,9 @@ class RenderRoute (Route a) => Yesod a where
      where
        corrected = filter (not . TS.null) s

-    -- | Join the pieces of a path together into an absolute URL. This should
-    -- be the inverse of 'splitPath'.
+    -- | Builds an absolute URL by concatenating the application root with the  
+    -- pieces of a path and a query string, if any. 
+    -- Note that the pieces of the path have been previously cleaned up by 'cleanPath'.
    joinPath :: a
             -> TS.Text -- ^ application root
             -> [TS.Text] -- ^ path pieces