Skip to content

Style guide

Page under construction: Fall back to PEP8 when needed

Names

How we name things is very important in software engineering and we should invest enough time in it. This can greatly increase or even enable software maintenance if done carefully. It can also help clarifying the design during implementation and avoid mistakes.

Prescriptions

Variables and function names should follow the snake_case convention (= lower_cased_words_separated_by_underscores).

valid_variable_name = "good job"

Names should be meaningful, explicit, specific, and carry information.