Skip to content

Standards (file, folder and object names, coding)

Michael Samuel edited this page Dec 5, 2018 · 3 revisions

Use commented lines of - and = to break up your file into easily readable chunks.

Load data ---------------------------

Plot data ---------------------------

In code, use comments to explain the “why” not the “what” or “how”. Each line of a comment should begin with the comment symbol and a single space: #.

Variable and function names should use only lowercase letters, numbers, and . Use underscores () (so called snake case) to separate words within a name. Generally, variable names should be nouns and function names should be verbs. Strive for names that are concise and meaningful (this is not easy!).

strive to use verbs for function names: