haskell/yesod
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fuller docs + version bump

Browse Source
This commit is contained in:
Bryan Richter 2016-02-02 08:59:01 -08:00
parent 4d48ba71be
commit 806dc5c629
No known key found for this signature in database
GPG Key ID: B202264020068BFB
3 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
yesod-newsfeed/ChangeLog.md
View File

@ -1,5 +1,9 @@
# Changelog # Changelog
## 1.6
* Create new datatype `EntryEnclosure` for self-documentation of `feedEntryEnclosure`.
## 1.5 ## 1.5
### Yesod/FeedTypes.hs ### Yesod/FeedTypes.hs

8
yesod-newsfeed/Yesod/FeedTypes.hs
View File

@ -28,6 +28,12 @@ data Feed url = Feed
, feedEntries :: [FeedEntry url] , 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 data EntryEnclosure url = EntryEnclosure
{ enclosedUrl :: url { enclosedUrl :: url
, enclosedSize :: Int -- ^ Specified in bytes , enclosedSize :: Int -- ^ Specified in bytes
@ -43,4 +49,6 @@ data FeedEntry url = FeedEntry
, feedEntryEnclosure :: Maybe (EntryEnclosure url) , feedEntryEnclosure :: Maybe (EntryEnclosure url)
-- ^ Allows enclosed data: RSS \<enclosure> or Atom \<link -- ^ Allows enclosed data: RSS \<enclosure> or Atom \<link
-- rel=enclosure> -- rel=enclosure>
--
-- @since 1.5
} }

2
yesod-newsfeed/yesod-newsfeed.cabal
View File

@ -1,5 +1,5 @@
name: yesod-newsfeed name: yesod-newsfeed
version: 1.5 version: 1.6
license: MIT license: MIT
license-file: LICENSE license-file: LICENSE
author: Michael Snoyman, Patrick Brisbin author: Michael Snoyman, Patrick Brisbin