Skip to content
Patrik Schönfeldt edited this page May 8, 2020 · 5 revisions

Discussion result from #442 - not yet decided!

Implements the REUSE initiative from FSFE and adapts the examples of REUSE Practices

Python files:

# -*- coding: utf-8 -*-

"""
Some module text...

This file is part of project oemof. It's copyrighted by the contributors
recorded in the version control history of the file, available from its original
location https://github.com/oemof/oemof-solph/file.py

SPDX-License-Identifier: MIT
"""

SQL and other:

/*
Some module text...

* This file is part of project oemof. It's copyrighted by the contributors
* recorded in the version control history of the file, available from
* its original location https://github.com/oemof/oemof-solph/file.py
* 
* SPDX-License-Identifier: MIT
*/

my code....

Decision from the oemof developer meeting - Berlin, December 6, 2016 #218.

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__ = "Copyright oemof developer group"
__license__ = "MIT"
__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__ = "Copyright oemof developer group"
__license__ = "MIT"
__author__ = "author1, author2"
*/

my code....