modified: docstrings modified

This commit is contained in:
Sebastian Wehling 2014-07-17 11:04:16 +02:00
parent 8de25cc149
commit dde360d4cc

View File

@ -1,9 +1,5 @@
#!/usr/bin/env python #!/usr/bin/env python
# # -*- coding: utf-8 -*-
# Provide user the opportunity to read arbitrary organized database
# types. This means e.g. seiscomp data structure (SDS) or event based
# EGELADOS structure.
#
import os import os
from obspy.core import (read, Stream) from obspy.core import (read, Stream)
@ -14,6 +10,11 @@ class Data(object):
''' '''
Data container class providing ObSpy-Stream and -Event instances as Data container class providing ObSpy-Stream and -Event instances as
variables. variables.
:type parent: PySide.QtGui.QWidget object, optional
:param parent: A PySide.QtGui.QWidget class utilized when
called by a GUI to display a PySide.QtGui.QMessageBox instead of printing
to standard out.
''' '''
def __init__(self, parent=None, wfdata=None, evtdata=None): def __init__(self, parent=None, wfdata=None, evtdata=None):
@ -71,9 +72,9 @@ class SeiscompDataStructure(object):
Dictionary containing the data acces information for an SDS data archive: Dictionary containing the data acces information for an SDS data archive:
:param str dataType: Desired data type. Default: ``'waveform'`` :param str dataType: Desired data type. Default: ``'waveform'``
:param date: Either date string or an instance of :param sdate, edate: Either date string or an instance of
:class:`obspy.core.utcdatetime.UTCDateTime. Default: ``None`` :class:`obspy.core.utcdatetime.UTCDateTime. Default: ``None``
:type date: str or UTCDateTime or None :type sdate, edate: str or UTCDateTime or None
''' '''
def __init__(self, dataType='waveform', sdate=None, edate=None, **kwargs): def __init__(self, dataType='waveform', sdate=None, edate=None, **kwargs):