document cache key

2014-10-02 09:11:23 -07:00 · 2014-10-02 09:11:23 -07:00 · 7f775e1dde
commit 7f775e1dde
parent d31e2d0988
1 changed files with 1 additions and 1 deletions
--- a/yesod-core/Yesod/Core/TypeCache.hs
+++ b/yesod-core/Yesod/Core/TypeCache.hs
@ -62,7 +62,7 @@ cached cache action = case clookup cache of
 -- Since 1.4.0
 cachedBy :: (Monad m, Typeable a)
         => KeyedTypeMap
-         -> ByteString
+         -> ByteString                     -- ^ a cache key
         -> m a                            -- ^ cache the result of this action
         -> m (Either (KeyedTypeMap, a) a) -- ^ Left is a cache miss, Right is a hit
 cachedBy cache k action = case clookup k cache of