From bead7a24c38506717d9ca97a27a3f686bb006fcc Mon Sep 17 00:00:00 2001 From: Sebastian Wehling-Benatelli Date: Tue, 1 Apr 2014 16:49:28 +0200 Subject: [PATCH] documentation updated in order to automatically provide online documentation via sphinx.ext.autodoc --- pylot/core/read/inputs.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/pylot/core/read/inputs.py b/pylot/core/read/inputs.py index cb48319a..fb57f2e3 100644 --- a/pylot/core/read/inputs.py +++ b/pylot/core/read/inputs.py @@ -6,9 +6,13 @@ class AutoPickParameter(object): ''' AutoPickParameters is a parameter type object capable to read and/or write parameter ASCII and binary files. + + :param fn str: Filename of the input file Parameters are given for example as follows: - + ========== ========== ======================================= + Name Value Comment + ========== ========== ======================================= phl S # phaselabel ff1 0.1 # freqmin ff2 0.5 # freqmax @@ -27,6 +31,7 @@ class AutoPickParameter(object): aerr 30;60 # adjusted_error_slope_fitting_loc_glob tsn 20;5;20;10 # length_signal_window_S/N proPh Sn # nextprominentphase + ========== ========== ======================================= ''' def __init__(self, fn=None):