Replies: 4 comments 3 replies
-
It looks like this can be linted with https://github.com/PyCQA/pydocstyle. |
Beta Was this translation helpful? Give feedback.
-
My natural preference is without the extra line, but I'd want to know why NumPy, SciPy, and the scikits choose to have it. Their guideline doesn't say anything about it. |
Beta Was this translation helpful? Give feedback.
-
Good idea. I would naturally prefer the nummy style guide, since we are part of the scientific python ecosystem. The thing with the empty line before the triple quotes seems useless to me but shouldn't be a decisive factor imho, it is rather pointless to discuss about such a matter |
Beta Was this translation helpful? Give feedback.
-
It might be useful to adopt a style guide for docstrings. Common ones:
For example, the NumPy style guide maintains a white line before the last
"""
, while the others do not.Beta Was this translation helpful? Give feedback.
All reactions