tvb-recon icon indicating copy to clipboard operation
tvb-recon copied to clipboard

NumPy style docstrings

Open maedoc opened this issue 9 years ago • 1 comments

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 avatar Feb 01 '17 08:02 maedoc

also for pre-commit checks

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

maedoc avatar Feb 01 '17 12:02 maedoc