For substantial project tasks, two people will be assigned.
Person 1 is the actual implementer, and will write basic test functions for their code.
Person 2 will review the code of Person 1, and write additional test functions as needed.
According to PEP 8 docstrings should be included
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.
At our October 21 group meeting, we decided to make sure we have comments
- at the start of a class definition (to explain the purpose of the class)
- within the constructor (i.e., the
__init__()
definition (to explain nonobvious aspects of object construction) - at the start of user-facing functions (to explain nonobvious aspects of function construction)
Regular comments (i.e., those preceded by #
) are brief in-line comments to fellow developers to help understand how the code works.