How docstrings should be written

Jump to bottom Edit New page

Johannes Röder edited this page Dec 2, 2021 · 6 revisions

Two types of docstrings:

network classes and function
constraints (blocks) - classes

For network classes / Functions / additional contstrains

<Header line>

<Further / detailed descriptions >

<Parameter>

<Formulas>

<Table> (optional, does not make sense everywhere)

<Examples>

For constraints (blocks) - classes

<Header line>

<Further / detailed descriptions >

-- oemof --