mirror of
https://github.com/namibia/awesome-cheatsheets.git
synced 2024-11-22 04:45:16 +00:00
39 lines
1.3 KiB
Python
39 lines
1.3 KiB
Python
# *****************************************************************************
|
|
# CODING STYLE > MAKING YOUR CODE READABLE
|
|
# *****************************************************************************
|
|
|
|
|
|
# 1. Avoid abbreviating variable names.
|
|
# 2. Write out your function argument names.
|
|
# 3. Document your classes and methods.
|
|
# 4. Comment your code.
|
|
# 5. Refactor repeated lines of code into reusable functions or methods.
|
|
# 6. Keep functions and methods short. A good rule of thumb is that scrolling
|
|
# should not be necessary to read an entire function or method.
|
|
|
|
# TIP: Use Flake8 for Checking Code Quality.
|
|
|
|
|
|
# *****************************************************************************
|
|
# CODING STYLE > THE WORD ON IMPORTS
|
|
# *****************************************************************************
|
|
|
|
|
|
# Imports should be grouped in the following order:
|
|
|
|
# 1. Standard library imports.
|
|
# 2. Core Django imports.
|
|
# 3. Third-party app imports.
|
|
# 4. Imports from your apps.
|
|
|
|
# Use explicit relative imports.
|
|
# Avoid using import *
|
|
|
|
|
|
# *****************************************************************************
|
|
# CODING STYLE > OTHERS
|
|
# *****************************************************************************
|
|
|
|
|
|
# Use underscores in URL pattern names rather than dashes.
|