Skip to content

Header and License

Ludee edited this page Dec 19, 2016 · 10 revisions

Taken and adapted from the oemof developer group

Python files:

"""This is the docstring for the example.py module.  Modules names should
have short, all-lowercase names.  The module name may have underscores if
this improves readability.
Every module should have a docstring at the very top of the file.  The
module's docstring may extend over multiple lines.  If your docstring does
extend over multiple lines, the closing three quotation marks must be on
a line by itself, preferably preceded by a blank line.
"""

__copyright__ = "tba"
__license__ = "tba"
__author__ = "author1, author2"

import some_package

my code....

SQL and other:

/*
A description of the module (short but could be more than one line).
Modules names should have short, all-lowercase names. 
The module name may have underscores if this improves readability.

__copyright__ = "tba"
__license__ = "tba"
__author__ = "author1, author2"
*/

my code....
Clone this wiki locally