Commit f82f8c5f authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Sphinx documentation of the Proceedings class.

parent c11553ff
harvest_tools.proceedings.Proceedings
=====================================
.. currentmodule:: harvest_tools.proceedings
.. autoclass:: Proceedings
:show-inheritance:
.. rubric:: Methods
.. autosummary::
:toctree: proceedings/
~Proceedings.check_record
~Proceedings.decode_xml
~Proceedings.get_create_collaboration
~Proceedings.get_create_publisher
~Proceedings.get_record_by_fields
~Proceedings.insert_record
~Proceedings.process_url
~Proceedings.process_xml
~Proceedings.report
harvest_tools.proceedings.Proceedings.check_record
==================================================
.. currentmodule:: harvest_tools.proceedings
.. automethod:: Proceedings.check_record
\ No newline at end of file
harvest_tools.proceedings.Proceedings.decode_xml
================================================
.. currentmodule:: harvest_tools.proceedings
.. automethod:: Proceedings.decode_xml
\ No newline at end of file
harvest_tools.proceedings.Proceedings.get_create_collaboration
==============================================================
.. currentmodule:: harvest_tools.proceedings
.. automethod:: Proceedings.get_create_collaboration
\ No newline at end of file
harvest_tools.proceedings.Proceedings.get_create_publisher
==========================================================
.. currentmodule:: harvest_tools.proceedings
.. automethod:: Proceedings.get_create_publisher
\ No newline at end of file
harvest_tools.proceedings.Proceedings.get_record_by_fields
==========================================================
.. currentmodule:: harvest_tools.proceedings
.. automethod:: Proceedings.get_record_by_fields
\ No newline at end of file
harvest_tools.proceedings.Proceedings.insert_record
===================================================
.. currentmodule:: harvest_tools.proceedings
.. automethod:: Proceedings.insert_record
\ No newline at end of file
harvest_tools.proceedings.Proceedings.process_url
=================================================
.. currentmodule:: harvest_tools.proceedings
.. automethod:: Proceedings.process_url
\ No newline at end of file
harvest_tools.proceedings.Proceedings.process_xml
=================================================
.. currentmodule:: harvest_tools.proceedings
.. automethod:: Proceedings.process_xml
\ No newline at end of file
harvest_tools.proceedings.Proceedings.report
============================================
.. currentmodule:: harvest_tools.proceedings
.. automethod:: Proceedings.report
\ No newline at end of file
......@@ -81,3 +81,10 @@ Classes
:toctree: generated/
Preprints
.. currentmodule:: harvest_tools.proceedings
.. autosummary::
:toctree: generated/
Proceedings
......@@ -18,12 +18,12 @@ class Proceedings(Automaton):
def check_record(self, record):
"""Check the content of the proceeding in order to fix non conformities.
@type record: L{Record}
@param record:
Args:
record (RecordConf): record describing a proceeding.
@rtype: bool
@return: C{False} when a non conformity is found and can not be
corrected.
Returns:
bool: ``False`` when a non conformity is found and can not be
corrected.
"""
if not Automaton.check_record(self, record):
......@@ -61,12 +61,12 @@ class Proceedings(Automaton):
def insert_record(self, record):
"""Insert a conference proceeding in the database.
@type record: L{Record}
@param record:
Args:
record (RecordConf): record describing a proceeding.
@rtype: int
@return: one when the record is inserted / updated in the database
zero otherwise.
Returns:
int: one when the record is inserted / updated in the database
zero otherwise.
"""
db = self.db
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment