Style guides refer to a set of standards for writing and formatting code. Having a consistent style guide makes it much easier to understand a large codebase. We recommend using the following style guides
Python
Python code should follow Generic coding conventions as specified in the Style Guide for Python Code (PEP 8).
...
CapWords
convention for Class namesUse
lowercase
orlowercase_with_underscores
for function, method, and variable names.For short names, joined lowercase may be used (e.g. "tagname"). Choose what is most readable.
No single-character variable names, except indices in loops that encompass a very small number of lines
Use
'single quotes'
for string literals, and"""triple double quotes"""
for docstrings.Use double quotes for strings when necessary like
"don't"
.
Guidelines
When contributing code, you should use a Linter.
A Linter is a tool that performs static source code analysis. The tool can check your code syntax and provide instructions on how to improve it.
...