diff --git a/src/libprs500/manual/news_recipe.rst b/src/libprs500/manual/news_recipe.rst index ef75be9fdc..3e5e3c25d2 100644 --- a/src/libprs500/manual/news_recipe.rst +++ b/src/libprs500/manual/news_recipe.rst @@ -36,6 +36,8 @@ Customizing e-book download .. automember:: BasicNewsRecipe.title +.. automember:: BasicNewsRecipe.description + .. automember:: BasicNewsRecipe.__author__ .. automember:: BasicNewsRecipe.max_articles_per_feed diff --git a/src/libprs500/web/feeds/news.py b/src/libprs500/web/feeds/news.py index 8e661dacd5..014c358863 100644 --- a/src/libprs500/web/feeds/news.py +++ b/src/libprs500/web/feeds/news.py @@ -32,10 +32,16 @@ class BasicNewsRecipe(object): #: The title to use for the ebook title = _('Unknown News Source') + #: A couple of lines that describe the content this recipe downloads. + #: This will be used primarily in a GUI that presents a list of recipes. + description = '' + #: The author of this recipe __author__ = __appname__ - #: Maximum number of articles to download from each feed + #: Maximum number of articles to download from each feed. This is primarily + #: useful for feeds that don't have article dates. For most feeds, you should + #: use :attr:`BasicNewsRecipe.oldest_article` max_articles_per_feed = 100 #: Oldest article to download from this news source. In days. @@ -852,4 +858,4 @@ class AutomaticNewsRecipe(BasicNewsRecipe): def fetch_embedded_article(self, article, dir, logger, f, a, num_of_feeds): if self.use_embedded_content: self.web2disk_options.keep_only_tags = [] - return BasicNewsRecipe.fetch_embedded_article(self, article, dir, logger, f, a, num_of_feeds) \ No newline at end of file + return BasicNewsRecipe.fetch_embedded_article(self, article, dir, logger, f, a, num_of_feeds)