PEP 8 -- Style Guide for Python Code PEP 3000 -- Python 3000
There is a good article on how to name variable names. Good variable names
Write documentation only if you think other developers may have problems with understanding functions, methods, classes, modules or packages.
Do not describe obvious things in documentation like:
#BAD! never do it!
def add(x, y):
"""Returns sum of x and y"""
return x + yDocstring style - Google Style Python Docstrings
- Run Pylint - Pylint website
- Run tests