search

Neuroinflab / kCSD-python

Kernel Current Source Density
https://kcsd-python.readthedocs.io/en/latest/
Other
15 stars 23 forks source link

Misleading (outdated) docstrings #89

Open abukaj opened 5 years ago

abukaj commented 5 years ago

I think the docstrings should be inspected and updated.

For example docstring for KCSD.create_lookup() suggests it has a parameter dist_table_density (it has not; it is provided as attribute): https://github.com/Neuroinflab/kCSD-python/blob/2ce755a0b43324e16053d8a2319b053f614abcd7/kcsd/KCSD.py#L131-L141 It also claims dist_table_density defaults to 100 while in the constructor it defaults to 20: https://github.com/Neuroinflab/kCSD-python/blob/2ce755a0b43324e16053d8a2319b053f614abcd7/kcsd/KCSD.py#L104

ccluri commented 5 years ago

Thanks Kuba!

Perhaps I should also bump this pending issue https://github.com/Neuroinflab/kCSD-python/issues/33