[add] docstrings in pylot/core/loc

pylot/core/loc/focmec.py

@@ -18,11 +18,11 @@ def export(picks, fnout, parameter, eventinfo):
     :param fnout: complete path to the exporting obs file
     :type fnout: str
     
-    :param: parameter, all input information
+    :param parameter: all input information
-    :type:  object
+    :type parameter:  object
 
-    :param: eventinfo, source information needed for focmec format
+    :param eventinfo: source information needed for focmec format
-    :type:  list object
+    :type eventinfo:  list object
     '''
     # write phases to FOCMEC-phase file
     writephases(picks, 'FOCMEC', fnout, parameter, eventinfo)

pylot/core/loc/hash.py

@@ -18,11 +18,11 @@ def export(picks, fnout, parameter, eventinfo):
     :param fnout: complete path to the exporting obs file
     :type fnout: str
     
-    :param: parameter, all input information
+    :param parameter: all input information
-    :type:  object
+    :type parameter:  object
 
-    :param: eventinfo, source information needed for HASH format
+    :param eventinfo: source information needed for HASH format
-    :type:  list object
+    :type eventinfo:  list object
     '''
     # write phases to HASH-phase file
     writephases(picks, 'HASH', fnout, parameter, eventinfo)

pylot/core/loc/hypo71.py

@@ -18,8 +18,8 @@ def export(picks, fnout, parameter):
     :param fnout: complete path to the exporting obs file
     :type fnout: str
 
-    :param: parameter, all input information
+    :param parameter: all input information
-    :type:  object
+    :type parameter:  object
     '''
     # write phases to HYPO71-phase file
     writephases(picks, 'HYPO71', fnout, parameter)

pylot/core/loc/hypodd.py

@@ -18,11 +18,11 @@ def export(picks, fnout, parameter, eventinfo):
     :param fnout: complete path to the exporting obs file
     :type fnout: str
     
-    :param: parameter, all input information
+    :param parameter: all input information
-    :type:  object
+    :type parameter:  object
 
-    :param: eventinfo, source information needed for hypoDD format
+    :param eventinfo: source information needed for hypoDD format
-    :type:  list object
+    :type eventinfo:  list object
     '''
     # write phases to hypoDD-phase file
     writephases(picks, 'hypoDD', fnout, parameter, eventinfo)

pylot/core/loc/hyposat.py

@@ -18,8 +18,8 @@ def export(picks, fnout, parameter):
     :param fnout: complete path to the exporting obs file
     :type fnout: str
     
-    :param: parameter, all input information
+    :param parameter: all input information
-    :type:  object
+    :type parameter:  object
     '''
     # write phases to HYPOSAT-phase file
     writephases(picks, 'HYPOSAT', fnout, parameter)

pylot/core/loc/nll.py

@@ -28,8 +28,8 @@ def export(picks, fnout, parameter):
     :param fnout: complete path to the exporting obs file
     :type fnout: str
  
-    :param: parameter, all input information
+    :param parameter: all input information
-    :type:  object
+    :type parameter:  object
     '''
     # write phases to NLLoc-phase file
     writephases(picks, 'NLLoc', fnout, parameter)
@@ -38,19 +38,19 @@ def export(picks, fnout, parameter):
 def modify_inputs(ctrfn, root, nllocoutn, phasefn, tttn):
     '''
     :param ctrfn: name of NLLoc-control file
-    :type: str
+    :type ctrfn: str
 
     :param root: root path to NLLoc working directory
-    :type: str
+    :type root: str
 
     :param nllocoutn: name of NLLoc-location output file
-    :type: str
+    :type nllocoutn: str
 
     :param phasefn: name of NLLoc-input phase file
-    :type: str
+    :type phasefn: str
 
     :param tttn: pattern of precalculated NLLoc traveltime tables
-    :type: str
+    :type tttn: str
     '''
     # For locating the event the NLLoc-control file has to be modified!
     # create comment line for NLLoc-control file NLLoc-output file
@@ -75,9 +75,9 @@ def modify_inputs(ctrfn, root, nllocoutn, phasefn, tttn):
 
 def locate(fnin, infile=None):
     """
-    takes an external program name
+    takes an external program name and tries to run it
-    :param fnin:
+    :param fnin: external program name
-    :return:
+    :return: None
     """
 
     if infile is None:

pylot/core/loc/velest.py

@@ -18,11 +18,11 @@ def export(picks, fnout, eventinfo, parameter=None):
     :param fnout: complete path to the exporting obs file
     :type fnout: str
     
-    :param: eventinfo, source time needed for VELEST-cnv format
+    :param eventinfo: source time needed for VELEST-cnv format
-    :type:  list object
+    :type eventinfo:  list object
 
-    :param: parameter, all input information
+    :param parameter: all input information
-    :type:  object
+    :type parameter:  object
     '''
     # write phases to VELEST-phase file
     writephases(picks, 'VELEST', fnout, parameter, eventinfo)