Code Quality Guidelines

Code Quality Guidelines

When coding for Gazelle please make sure your code adheres to the following:

• Gazelle does not need to strictly follow the pep8 standard, however
  • Line length should around 80 characters unless you absolutely need to go over, in which case try not to exceed 110 characters
  • Try to make code as uncluttered as possible. Liberal use of newlines and spaces are encouraged
  • Use descriptive variable and function names
    • With the exception of lambdas
• Always comment and thoroughly explain what your code does if not extremely obvious
• Use line comments above functions to describe what objects they operate on and return
• Use docstring comments under your class definition to describe what the class does
• single-quotes > double-quotes. Use single quotes where you can.
• Keep everything neatly spaced in stdenv.py and make sure there is documentation for each non-mathematical function for in the documentation wiki page