code_style

Jump to bottom

Roald Lemmen edited this page Jun 20, 2018 · 1 revision

Suggest aiming for a consistent style in our __init__.py files:

include a substantial module-level docstring (several paragraphs and examples if necessary, smif.model is a good example)
do not include any classes or functions
import anything from adjacent modules that should be exposed directly on the subpackage and define all = [...] (see smif.data_layer for example)

ITRC Banner