Coding Convetions - gergopokol/renate-od GitHub Wiki

This page contains the rules of coding.

The underlying naming convention to be followed is PEP8 (https://www.python.org/dev/peps/pep-0008/), as it was designed for python and is enforced by pythonic infrastructures such as PyCharm from JetBrains. Conventions that deviate from the before mentioned should be discussed.

• Naming
  • classes: noun, first letter is uppercase > class MyClass
  • methods: verb, first letter is lowercase > def doMyThing (according to PEP8 --> def do_my_thing)
  • modules: noun, first letter is lowercase
  • variables: noun, first letter is lowercase
• KISS = keep it simple, stupid
• Editing
  • Line width 120 chars (In PyCharm: File > Settings > Editor > Code Style > Python > Hard wrap at)