MPBA / pyphysio

GNU General Public License v3.0
47 stars 13 forks source link

_param_descriptors removal #37

Closed andbiz closed 6 years ago

andbiz commented 7 years ago

Provide documentation through __init__ instead of _params_descriptors

Alebat commented 7 years ago

Should we completely remove _paramsdescriptors? How do we do the sanity check for parameters? **Through assertions in __init_\ Isn't it ugly to put assertions? No, parameters should have correct values**

Alebat commented 7 years ago

I think it is better to split the task in four phases:

Alebat commented 7 years ago

Now you can use the script! E.g. for InBand(freq_min, freq_max, method, [freq], [psd]) $ python initize.py _Indicator freq_min freq_max method ?freq ?psd Gives as output:

def __init__(self, freq_min, freq_max, method, freq=None, psd=None, **kwargs):
    _Indicator.__init__(self, freq_min=freq_min, freq_max=freq_max, method=method, freq=freq, psd=psd, **kwargs)
Alebat commented 7 years ago

@andbiz can you search for "Andrea" in the project? There are some pending fixes. If you can check also the other TODOs please.

Alebat commented 7 years ago