search

neuroinformatics-unit / python-cookiecutter

Utility to create a basic Python project structure with tests, CI etc.
BSD 3-Clause "New" or "Revised" License
24 stars 3 forks source link

Add documentation/example of docstrings #4

Closed adamltyson closed 1 year ago

adamltyson commented 2 years ago

To enforce a consistent style, it would be useful to maybe add an example (numpy) docstring somewhere in the project, and detail how to add these docstrings.

Linked to https://github.com/SainsburyWellcomeCentre/python-cookiecutter/issues/3