Skip to content

Latest commit

 

History

History
11 lines (9 loc) · 685 Bytes

STYLE_GUIDELINES.md

File metadata and controls

11 lines (9 loc) · 685 Bytes

Style Guidelines

The Hedgehogs style guidelines in terms of code style are flexible

Hedgehogs requires that code follow these stipulations:

  • Comment functions with docstrings
  • Use inline comments for any non-trivial code
  • Avoid long lines greater than 72 characters
  • Split a function into separate functions if too many lines of code are used
  • Keep code to one statement per line and explicit
  • Always surround these binary operators with a single space on either side: assignment (=), augmented assignment (+=, -= etc.), comparisons (==, <, >, !=, <>, <=, >=, in, not in, is, is not), Booleans (and, or, not)