Skip to content

Latest commit

 

History

History
11 lines (10 loc) · 937 Bytes

STYLEGUIDE.md

File metadata and controls

11 lines (10 loc) · 937 Bytes
Raw

Style guide

  • Use type hints.
  • Follow the PEP8 styleguide.
    • The only exception: we use a maximum character limit of 120 characters per line.
    • Black and Pylint will enforce this.
  • Write docstrings in Numpy format, with a few tweaks:
    • Use "Arguments" instead of "Parameters".
    • Don't use space before : in the type specification. Sphinx and VSCode render it the same, and it's closer to the signature.
  • Document each class attribute immediately after its declaration (example)
  • When in doubt, lean in the direction of verbosity and readability.