From 5f43576f262d09adfc7eca908632cac264cbd968 Mon Sep 17 00:00:00 2001 From: Lars Kiesow Date: Thu, 21 Dec 2023 23:10:50 +0100 Subject: [PATCH] Improve module documentation This patch updates the modules description in `__init__.py` which was a bit weird. This closes #102 --- feedgen/__init__.py | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/feedgen/__init__.py b/feedgen/__init__.py index 624658e..b28c0e9 100644 --- a/feedgen/__init__.py +++ b/feedgen/__init__.py @@ -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