raj1701
commented
1 year ago Hey @jasmainak, across which all files or functions do the docstrings need to be made consistent. Or should similar functions across all files have consistent doc strings??
Open jasmainak opened 3 years ago
raj1701
commented
1 year ago Hey @jasmainak, across which all files or functions do the docstrings need to be made consistent. Or should similar functions across all files have consistent doc strings??
SamruddhiNavale
commented
6 months ago Hello @ntolley @jasmainak , I am working on this issue and specifically on params.py file Interested to contribute to hnn-core. GSOC 2024
My PR: https://github.com/jonescompneurolab/hnn-core/pull/743
Please review and let me know if any changes are required. THANK YOU
@ntolley pointed out in #376 that we could make the docstrings more consistent. I think this is a great suggestion and merits a separate PR.
Down the line, we could also do something like this in MNE: https://github.com/mne-tools/mne-python/blob/3ea17053b81df811e4a13f01985bce2f2d0291e6/mne/externals/doccer.py
It might increase complexity and barrier to entry for first-time contributors though, so perhaps worth bringing this in after the repository matures a bit.