1. Style guide

1.1. Sphinx documentation

  • Section headings should be as brief as possible (e.g. a few words) without a full stop e.g.

    ## Sphinx documentation
    

1.2. Jupyter notebook tutorials

All python code should follow the python PEP8 style guide. We will be using the google PEP8 Style guide which provides extensive examples on how to apply the guidelines.

  • Variable should be in lower_case_with_underscores.

  • Comments should begin should be full sentences:

    # This is a comment.