Skip to content

Commit

Permalink
Add feed and entry attribute docstrings.
Browse files Browse the repository at this point in the history
Part of #28.
  • Loading branch information
lemon24 committed May 6, 2018
1 parent d234688 commit 88b5ad2
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions reader/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,23 +30,51 @@ def _asdict(self):

@attr.s(slots=True, frozen=True)
class Feed(attrs_namedtuple_compat):

#: The URL of the feed.
url = attr.ib()

#: The date the feed was last updated.
updated = attr.ib(default=None)

#: The title of the feed.
title = attr.ib(default=None)

#: The URL of a page associated with the feed.
link = attr.ib(default=None)

#: User-defined feed title.
user_title = attr.ib(default=None)


@attr.s(slots=True, frozen=True)
class Entry(attrs_namedtuple_compat):

#: Entry identifier.
id = attr.ib()

#: The date the entry was last updated.
updated = attr.ib()

#: The title of the entry.
title = attr.ib(default=None)

#: The URL of a page associated with the entry.
link = attr.ib(default=None)

#: The date the entry was first published.
published = attr.ib(default=None)

#: A summary of the entry.
summary = attr.ib(default=None)

#: Entry content. An iterable of :class:`Content` objects.
content = attr.ib(default=None)

#: Entry enclosures. An iterable of :class:`Enclosure` objects.
enclosures = attr.ib(default=None)

#: Whether the entry was read or not.
read = attr.ib(default=False)


Expand Down

0 comments on commit 88b5ad2

Please sign in to comment.