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

DOCS: Check spelling in docstrings #990

Open
asoplata opened this issue Feb 3, 2025 · 0 comments
Open

DOCS: Check spelling in docstrings #990

asoplata opened this issue Feb 3, 2025 · 0 comments
Labels
docs Documentation and tutorials good first issue Good for newcomers

Comments

@asoplata
Copy link
Collaborator

asoplata commented Feb 3, 2025

Problem: Currently, our automated spell-checking tests ( https://github.com/codespell-project/codespell ) only check for common misspellings. This means that occasionally, our code and documentation can contain uncommon spelling errors (example: https://github.com/jonescompneurolab/hnn-core/blob/master/hnn_core/parallel_backends.py#L597 ).

Solution: We need someone to help with checking our current docstrings etc. for typos, misspellings, and grammar errors that are very confusing. This doesn't have to done for every docstring every where, but any amount of help is useful.

@asoplata asoplata added docs Documentation and tutorials good first issue Good for newcomers labels Feb 3, 2025
@asoplata asoplata changed the title Check spelling in docstrings DOCS: Check spelling in docstrings Feb 3, 2025
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

1 participant