diff --git a/yesod-newsfeed/ChangeLog.md b/yesod-newsfeed/ChangeLog.md index 821ac2ff..eaaf8753 100644 --- a/yesod-newsfeed/ChangeLog.md +++ b/yesod-newsfeed/ChangeLog.md @@ -1,5 +1,9 @@ # Changelog +## 1.6 + +* Create new datatype `EntryEnclosure` for self-documentation of `feedEntryEnclosure`. + ## 1.5 ### Yesod/FeedTypes.hs diff --git a/yesod-newsfeed/Yesod/FeedTypes.hs b/yesod-newsfeed/Yesod/FeedTypes.hs index c9b1fd1d..f235929b 100644 --- a/yesod-newsfeed/Yesod/FeedTypes.hs +++ b/yesod-newsfeed/Yesod/FeedTypes.hs @@ -28,6 +28,12 @@ data Feed url = Feed , feedEntries :: [FeedEntry url] } +-- | RSS and Atom allow for linked content to be enclosed in a feed entry. +-- This represents the enclosed content. +-- +-- Atom feeds ignore 'enclosedSize' and 'enclosedMimeType'. +-- +-- @since 1.6 data EntryEnclosure url = EntryEnclosure { enclosedUrl :: url , enclosedSize :: Int -- ^ Specified in bytes @@ -43,4 +49,6 @@ data FeedEntry url = FeedEntry , feedEntryEnclosure :: Maybe (EntryEnclosure url) -- ^ Allows enclosed data: RSS \ or Atom \ + -- + -- @since 1.5 } diff --git a/yesod-newsfeed/yesod-newsfeed.cabal b/yesod-newsfeed/yesod-newsfeed.cabal index c98f0171..b8d57c7d 100644 --- a/yesod-newsfeed/yesod-newsfeed.cabal +++ b/yesod-newsfeed/yesod-newsfeed.cabal @@ -1,5 +1,5 @@ name: yesod-newsfeed -version: 1.5 +version: 1.6 license: MIT license-file: LICENSE author: Michael Snoyman, Patrick Brisbin