consider changing the docstring style

NLeSC / python-template

Netherlands eScience Center Python Template

https://research-software-directory.org/software/nlesc-python-template

Apache License 2.0

163 stars 73 forks source link

consider changing the docstring style #293

Open jspaaks opened 3 years ago

jspaaks commented 3 years ago

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

bouweandela commented 3 years ago

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.

egpbos commented 2 years ago

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