STYLE_GUIDE.md

Style Guide

• Remember The Zen of Python
• The repository styleguide is based on the Google Python Style Guide.
• The repository uses pre-commit to enforce the styleguide.

Naming

• Use descriptive names for tests, variables, functions, classes, etc.
• Meaningful names are better than short names.
• Do not use single-letter names.

Documentation

• Use Google-format for docstrings.
• Add docstrings to document functions, classes, and modules.
• Avoid inline comments; Write self-explanatory code that can be easily understood.
  Only add comments when necessary. For example, when using complex regex.

Typing

• Add typing to new code; typing is enforced using mypy
• Rules are defined in our pyproject.toml file
• For more information, see typing