Commit 73820e3e authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Sphinx documentation for the Report class.

parent f82f8c5f
harvest_tools.reports.Reports
=============================
.. currentmodule:: harvest_tools.reports
.. autoclass:: Reports
:show-inheritance:
.. rubric:: Methods
.. autosummary::
:toctree: reports/
~Reports.check_record
~Reports.decode_xml
~Reports.get_create_collaboration
~Reports.get_create_publisher
~Reports.get_record_by_fields
~Reports.insert_record
~Reports.process_url
~Reports.process_xml
~Reports.report
harvest_tools.reports.Reports.check_record
==========================================
.. currentmodule:: harvest_tools.reports
.. automethod:: Reports.check_record
\ No newline at end of file
harvest_tools.reports.Reports.decode_xml
========================================
.. currentmodule:: harvest_tools.reports
.. automethod:: Reports.decode_xml
\ No newline at end of file
harvest_tools.reports.Reports.get_create_collaboration
======================================================
.. currentmodule:: harvest_tools.reports
.. automethod:: Reports.get_create_collaboration
\ No newline at end of file
harvest_tools.reports.Reports.get_create_publisher
==================================================
.. currentmodule:: harvest_tools.reports
.. automethod:: Reports.get_create_publisher
\ No newline at end of file
harvest_tools.reports.Reports.get_record_by_fields
==================================================
.. currentmodule:: harvest_tools.reports
.. automethod:: Reports.get_record_by_fields
\ No newline at end of file
harvest_tools.reports.Reports.insert_record
===========================================
.. currentmodule:: harvest_tools.reports
.. automethod:: Reports.insert_record
\ No newline at end of file
harvest_tools.reports.Reports.process_url
=========================================
.. currentmodule:: harvest_tools.reports
.. automethod:: Reports.process_url
\ No newline at end of file
harvest_tools.reports.Reports.process_xml
=========================================
.. currentmodule:: harvest_tools.reports
.. automethod:: Reports.process_xml
\ No newline at end of file
harvest_tools.reports.Reports.report
====================================
.. currentmodule:: harvest_tools.reports
.. automethod:: Reports.report
\ No newline at end of file
......@@ -88,3 +88,10 @@ Classes
:toctree: generated/
Proceedings
.. currentmodule:: harvest_tools.reports
.. autosummary::
:toctree: generated/
Reports
......@@ -21,12 +21,12 @@ class Reports(Automaton):
def check_record(self, record):
"""Check the content of the report in order to fix non conformities.
@type record: L{Record}
@param record:
Args:
record (RecordPubli): record describing a report.
@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):
......@@ -58,14 +58,14 @@ class Reports(Automaton):
return True
def insert_record(self, record):
"""INsert a report in the database.
"""Insert a report in the database.
@type record: L{Record}
@param record:
Args:
record (RecordPubli): record describing a report.
@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