Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve module documentation #128

Merged
merged 1 commit into from
Dec 21, 2023
Merged

Improve module documentation #128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions feedgen/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,17 +62,15 @@

To add entries (items) to a feed you need to create new FeedEntry objects
and append them to the list of entries in the FeedGenerator. The most
convenient way to go is to use the FeedGenerator itself for the
instantiation of the FeedEntry object::
convenient way to do this, is to call the method add_entry(...) like this::

>>> fe = fg.add_entry()
>>> fe.id('http://lernfunk.de/media/654321/1')
>>> fe.title('The First Episode')

The FeedGenerators method add_entry(...) without argument provides will
automatically generate a new FeedEntry object, append it to the feeds
internal list of entries and return it, so that additional data can be
added.
The FeedGenerator's method add_entry(...) will automatically create a new
FeedEntry object, append it to the feeds internal list of entries and
return it, so that additional data can be added.

----------
Extensions
Expand Down