Document that bodies go into content_html

C.f. #975 (comment)
jaspervdj · Aug 6, 2023 · 1456f3e · 1456f3e
1 parent 06978c2
commit 1456f3e
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/Hakyll/Web/Feed.hs b/lib/Hakyll/Web/Feed.hs
@@ -223,6 +223,9 @@ renderAtom = renderAtomWithTemplates atomTemplate atomItemTemplate
 
 --------------------------------------------------------------------------------
 -- | Render a JSON feed with a number of items.
+--
+-- Items' bodies will be put into @content_html@ field of the resulting JSON;
+-- the @content@ field will not be set.
 renderJson :: FeedConfiguration       -- ^ Feed configuration
            -> Context String          -- ^ Item context
            -> [Item String]           -- ^ Feed items