Skip to content

styleguide.rst

Latest commit

 

History

History
23 lines (14 loc) · 1.25 KB

styleguide.rst

File metadata and controls

23 lines (14 loc) · 1.25 KB

Implementation Guide

Within a class implementation, variables with leading underscores are used to signify that they are not intended to be part of the public API.

If variables without the leading underscore are used, it typically means the following:

  1. If we are setting the variable, it is likely implemented as a property that does the proper checks (bounds checking, type checking, etc.)
  2. If we are accessing the variable, we are probably using the public API of an object that isn't implemented in the current class definition. This is a common pattern for classes that use composition
  3. If the usage doesn't fall under the points above, it could be we were lazy and haven't implemented the proper checks on the variable yet

Coding Conventions

In adherence with PEP 8, underscore_case is used for variables and function definitions. TitleCase signifies a class. lowerCamelCase is almost always avoided, except where it's the convention, such as for Qt programming. Mixing cases e.g.

mehData_fromExperiment

is a no-no.

If variable names begin with an upper case, this is due to mathematical convention. An example is Fourier transform pairs x <--> X; L, N for data lengths, etc.