proofofconcept icon indicating copy to clipboard operation
proofofconcept copied to clipboard

Published 20 hours ago • verified publisher icon allofphysicsgraph

improve docstrings

Open bhpayne opened this issue 4 years ago • 1 comments

https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings

https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings

bhpayne avatar Aug 10 '20 22:08 bhpayne

https://realpython.com/documenting-python-code/ is mostly review. The useful section for me was a demo of the various styles -- https://realpython.com/documenting-python-code/#docstring-formats

bhpayne avatar Aug 16 '20 00:08 bhpayne