This commit is contained in:
Kovid Goyal 2017-03-11 08:39:42 +05:30
parent 194bb9aee7
commit b52ef8956c
2 changed files with 3 additions and 0 deletions

View File

@ -421,6 +421,7 @@ class MetadataReaderPlugin(Plugin): # {{{
Return metadata for the file represented by stream (a file like object Return metadata for the file represented by stream (a file like object
that supports reading). Raise an exception when there is an error that supports reading). Raise an exception when there is an error
with the input data. with the input data.
:param type: The type of file. Guaranteed to be one of the entries :param type: The type of file. Guaranteed to be one of the entries
in :attr:`file_types`. in :attr:`file_types`.
:return: A :class:`calibre.ebooks.metadata.book.Metadata` object :return: A :class:`calibre.ebooks.metadata.book.Metadata` object
@ -452,6 +453,7 @@ class MetadataWriterPlugin(Plugin): # {{{
Set metadata for the file represented by stream (a file like object Set metadata for the file represented by stream (a file like object
that supports reading). Raise an exception when there is an error that supports reading). Raise an exception when there is an error
with the input data. with the input data.
:param type: The type of file. Guaranteed to be one of the entries :param type: The type of file. Guaranteed to be one of the entries
in :attr:`file_types`. in :attr:`file_types`.
:param mi: A :class:`calibre.ebooks.metadata.book.Metadata` object :param mi: A :class:`calibre.ebooks.metadata.book.Metadata` object

View File

@ -829,6 +829,7 @@ class BasicNewsRecipe(Recipe):
Called when each HTML page belonging to article is downloaded. Called when each HTML page belonging to article is downloaded.
Intended to be used to get article metadata like author/summary/etc. Intended to be used to get article metadata like author/summary/etc.
from the parsed HTML (soup). from the parsed HTML (soup).
:param article: A object of class :class:`calibre.web.feeds.Article`. :param article: A object of class :class:`calibre.web.feeds.Article`.
If you change the summary, remember to also change the If you change the summary, remember to also change the
text_summary text_summary