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

NumPy style docstrings #21

Open
maedoc opened this issue Feb 1, 2017 · 1 comment
Open

NumPy style docstrings #21

maedoc opened this issue Feb 1, 2017 · 1 comment
Assignees
Labels

Comments

@maedoc
Copy link
Member

maedoc commented Feb 1, 2017

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:

  • File | Settings | Tools | Python Integrated Tools for Windows and Linux
  • PyCharm | Preferences | Tools | Python Integrated Tools for OS X

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.

@maedoc maedoc added the task label Feb 1, 2017
@maedoc maedoc self-assigned this Feb 1, 2017
@maedoc
Copy link
Member Author

maedoc commented Feb 1, 2017

also for pre-commit checks

  • autopep8 (find tvb -name '*.py' -exec autopep8 --in-place '{}' \;)
  • flake8
  • mypy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant