python-template icon indicating copy to clipboard operation
python-template copied to clipboard

Published 20 hours ago • verified publisher icon NLeSC

consider changing the docstring style

Open jspaaks opened this issue 3 years ago • 2 comments

because its restructured text format is currently at odds with the markdown used in other places

jspaaks avatar May 04 '21 08:05 jspaaks

Note that this repository should be aligned with what is recommended in the guide. It looks like we recommend google style docstrings at the moment. If it is changed here, it should also be changed in the guide and vice versa.

bouweandela avatar May 18 '21 09:05 bouweandela

Where do we define the docstring style in this repo? I would recommend adding linting of docstrings and indeed setting it to Google style by default. We have also done so in the DIANNA project, if someone wants to copy from there: https://github.com/dianna-ai/dianna/blob/40148ae9365f2444df578484adb8104b4bee3506/.prospector.yml#L34

egpbos avatar Mar 30 '22 11:03 egpbos