Skip to content

Commit

Permalink
Improve module documentation
Browse files Browse the repository at this point in the history
This patch updates the modules description in `__init__.py` which was a
bit weird.

This closes #102
  • Loading branch information
lkiesow committed Dec 21, 2023
1 parent 984d62f commit 5f43576
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions feedgen/__init__.py
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

0 comments on commit 5f43576

Please sign in to comment.