earthpy icon indicating copy to clipboard operation
earthpy copied to clipboard

PEP multiline docstrings

Open lwasser opened this issue 6 years ago • 3 comments

Following @mbjoseph comment in this pr

Super minor thing but do we want to adhere to PEP 257 for multiline docstrings? https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings

I'm thinking specifically about this bit: 

    Multi-line docstrings consist of a summary line just like a one-line docstring, followed by a blank line, followed by a more elaborate description. 

let's talk about whether we want to implement this throughout earthpy - this would include the functions AND the tests!!

lwasser avatar Jan 31 '19 17:01 lwasser

Here's an example: https://github.com/earthlab/earthpy/blob/master/earthpy/spatial.py#L350-L395

mbjoseph avatar Feb 14 '19 21:02 mbjoseph

We will implement following the example above for bytescale pep 257 format with a short overview and a longer description as it's needed.

lwasser avatar Feb 14 '19 21:02 lwasser

I believe this issue was addressed in PR #246

PowerChell avatar Apr 26 '19 23:04 PowerChell