summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTroels Henriksen <athas@sigkill.dk>2012-02-17 16:25:00 +0100
committerTroels Henriksen <athas@sigkill.dk>2012-02-17 16:25:00 +0100
commit80f385c36110d90bab5e0cf085d557d546911eb6 (patch)
tree2fe71fbf77224e37c2d1040f642fa34711b45af7
parentff8bb310a420cc3c59064ba8481f672d131ad3b6 (diff)
downloadhakyll-80f385c36110d90bab5e0cf085d557d546911eb6.tar.gz
Mention how groups work with Hakyll.Core.Rules.create.
-rw-r--r--src/Hakyll/Core/Rules.hs4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/Hakyll/Core/Rules.hs b/src/Hakyll/Core/Rules.hs
index 2e3e52c..bef480a 100644
--- a/src/Hakyll/Core/Rules.hs
+++ b/src/Hakyll/Core/Rules.hs
@@ -140,7 +140,9 @@ compile compiler = do
-- This sets a compiler for the given identifier. No resource is needed, since
-- we are creating the item from scratch. This is useful if you want to create a
-- page on your site that just takes content from other items -- but has no
--- actual content itself.
+-- actual content itself. Note that the group of the given identifier is
+-- replaced by the group set via 'group' (or 'Nothing', if 'group' has not been
+-- used).
--
create :: (Binary a, Typeable a, Writable a)
=> Identifier a -> Compiler () a -> RulesM (Identifier a)