search

vvoelz / biceps

Bayesian inference of conformational populations
https://github.com/vvoelz/biceps
Other
12 stars 3 forks source link

"docstrings" #33

Closed robraddi closed 3 years ago

robraddi commented 6 years ago

Documentation Strings Conventions for writing good documentation strings (a.k.a. "docstrings") are immortalized in PEP 257. Write docstrings for all public modules, functions, classes, and methods. Docstrings are not necessary for non-public methods, but you should have a comment that describes what the method does. This comment should appear after the def line. PEP 257 describes good docstring conventions. Note that most importantly, the """ that ends a multiline docstring should be on a line by itself, e.g.: """Return a foobang Optional plotz says to frobnicate the bizbaz first. """ For one liner docstrings, please keep the closing """ on the same line.

robraddi commented 6 years ago

Here's a little .rst cheatsheet to check out when editing the docstrings