Change some comments from 'class:MetaInformation' to 'class:Metadata'

This commit is contained in:
Charles Haley 2010-09-05 11:06:54 +01:00
parent 0ba513e287
commit 38c6199c7b
4 changed files with 5 additions and 5 deletions

View File

@ -218,7 +218,7 @@ class MetadataReaderPlugin(Plugin): # {{{
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.MetaInformation` object :return: A :class:`calibre.ebooks.metadata.book.Metadata` object
''' '''
return None return None
# }}} # }}}
@ -248,7 +248,7 @@ class MetadataWriterPlugin(Plugin): # {{{
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.MetaInformation` object :param mi: A :class:`calibre.ebooks.metadata.book.Metadata` object
''' '''
pass pass

View File

@ -872,7 +872,7 @@ class ITUNES(DriverBase):
once uploaded to the device. len(names) == len(files) once uploaded to the device. len(names) == len(files)
:return: A list of 3-element tuples. The list is meant to be passed :return: A list of 3-element tuples. The list is meant to be passed
to L{add_books_to_metadata}. to L{add_books_to_metadata}.
:metadata: If not None, it is a list of :class:`MetaInformation` objects. :metadata: If not None, it is a list of :class:`Metadata` objects.
The idea is to use the metadata to determine where on the device to The idea is to use the metadata to determine where on the device to
put the book. len(metadata) == len(files). Apart from the regular put the book. len(metadata) == len(files). Apart from the regular
cover (path to cover), there may also be a thumbnail attribute, which should cover (path to cover), there may also be a thumbnail attribute, which should

View File

@ -164,7 +164,7 @@ def get_cover(opf, opf_path, stream, reader=None):
return render_html_svg_workaround(cpage, default_log) return render_html_svg_workaround(cpage, default_log)
def get_metadata(stream, extract_cover=True): def get_metadata(stream, extract_cover=True):
""" Return metadata as a :class:`MetaInformation` object """ """ Return metadata as a :class:`Metadata` object """
stream.seek(0) stream.seek(0)
reader = OCFZipReader(stream) reader = OCFZipReader(stream)
mi = MetaInformation(reader.opf) mi = MetaInformation(reader.opf)

View File

@ -29,7 +29,7 @@ class MetadataSource(Plugin): # {{{
future use. future use.
The fetch method must store the results in `self.results` as a list of The fetch method must store the results in `self.results` as a list of
:class:`MetaInformation` objects. If there is an error, it should be stored :class:`Metadata` objects. If there is an error, it should be stored
in `self.exception` and `self.tb` (for the traceback). in `self.exception` and `self.tb` (for the traceback).
''' '''