DeveloperGuidelines

Code Conventions

These conventions should be followed in all code:

• ​http://code.google.com/p/soc/wiki/PythonStyleGuide
  • Limit line length to 80 characters
• Use " " for strings, UNLESS the string contains a ", in which case use '
• All functions outside of classes should have the prefix shn_<Model Name>_
• All classes which over-ride existing classed should have the suffix "S3"
• Some automated bug analysis / code quality checking tools -
  • ​PyLint
    • gives detailed report
    • code quality score tells exact impact of the changes made
    • ​http://www.logilab.org/card/pylint_tutorial
  • ​PyChecker recommended in ​PythonStyleGuide

DeveloperGuidelines