Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

consistency between arguments in docstrings #387

Open
jasmainak opened this issue Jul 6, 2021 · 2 comments
Open

consistency between arguments in docstrings #387

jasmainak opened this issue Jul 6, 2021 · 2 comments
Labels
docs Documentation and tutorials good first issue Good for newcomers

Comments

@jasmainak
Copy link
Collaborator

@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.

@jasmainak jasmainak added docs Documentation and tutorials good first issue Good for newcomers labels Jul 6, 2021
@raj1701
Copy link
Contributor

raj1701 commented Mar 7, 2023

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
Copy link

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: #743

Please review and let me know if any changes are required.
THANK YOU

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation and tutorials good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants