DOC: Add description for blank lines after the docstring. #229
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is mainly a discussion, I notice that there is a blank line between the closing quotes and the
pass
:... """ pass
But from the PEP 257, it seems that there are no blank lines after the function docstring (no specific statement, but the examples in it don't contain the blank line). And the blank line separation only requires for class docstring:
So I am wondering: should we specifically suggest no the blank line after the functions/methods docstring OR it just doesn't matter and people can choose whatever they like?