-
Notifications
You must be signed in to change notification settings - Fork 21
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
NumPy style docstrings #21
Labels
Comments
also for pre-commit checks
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
As a project in the scientific community, docstrings are expected to be in NumPy format. PyCharm defaults to
:param:
style, but it will do NumPy for you, just take a look in the right place:and change "Docstring Format" to "NumPy". If it's not present, upgrade PyCharm.
This task is to rewrite the existing ones and add a pre-commit check.
The text was updated successfully, but these errors were encountered: