Pattern: Missing documentation
Issue: -
Docstrings may help you to remember the intention methods, functions, classes or modules. This is especially important as your codebase grows and it becomes harder to remember the implementation details of each object. Other developers will also have it easier to understand your code.
Example of incorrect code:
def complex(real=0.0, imag=0.0):
if imag == 0.0 and real == 0.0:
return complex_zero
...Example of correct code:
def complex(real=0.0, imag=0.0):
"""Form a complex number.
Keyword arguments:
real -- the real part (default 0.0)
imag -- the imaginary part (default 0.0)
"""
if imag == 0.0 and real == 0.0:
return complex_zero
...