search

nipraxis-fall-2022 / diagnostics-NME

0 stars 4 forks source link

Improve docstrings to improve readability of the code #35

Open oesteban opened 1 year ago

oesteban commented 1 year ago

The core functions should feature a much more detailed description of what they are doing:

https://github.com/nipraxis-fall-2022/diagnostics-NME/blob/6653c8051c82cfd7d70e009b4d01cc82d02d74f0/findoutlie/outfind.py#L36

https://github.com/nipraxis-fall-2022/diagnostics-NME/blob/6653c8051c82cfd7d70e009b4d01cc82d02d74f0/findoutlie/outfind.py#L65

https://github.com/nipraxis-fall-2022/diagnostics-NME/blob/6653c8051c82cfd7d70e009b4d01cc82d02d74f0/findoutlie/outfind.py#L91

https://github.com/nipraxis-fall-2022/diagnostics-NME/blob/6653c8051c82cfd7d70e009b4d01cc82d02d74f0/findoutlie/outfind.py#L128