Update Code Guidelines on Docstrings in Documentation
The only thing the documentation currently says about docstrings is:
Use google docstrings and use Markdown.
I have been following this but generally we don't and I have been getting comments on this.
For example, we should not have a summary line at the top and space pad single line docstrings (!938 (comment 165367)). And I guess the most obvious thing is that we use single quotes. All this is easy to setup in for example the autoDocstring
extension in VScode but should probably be explicitly stated in the docs. We could even consider providing a custom template for autoDocstring
.