migra icon indicating copy to clipboard operation
migra copied to clipboard

Published 20 hours ago • verified publisher icon djrobstep

Docstrings

Open SKalt opened this issue 4 years ago • 4 comments

Working on #114, I've often been at a loss telling what a function does with its arguments and variables or what a class represents. Adding more docstrings would help make the code more comprehensible.

SKalt avatar Jan 20 '20 20:01 SKalt

Agree!

djrobstep avatar Jan 24 '20 03:01 djrobstep

Alright, what of the popular docstring formats do you prefer? The top contenders are pydoc, google, numpy, and epydoc.

SKalt avatar Jan 25 '20 18:01 SKalt

I think the google version is the least worst, so shall we go with that for now?

djrobstep avatar Feb 27 '20 02:02 djrobstep

Agreed.

SKalt avatar Feb 27 '20 12:02 SKalt