Skip to content

[Guidelines] Header #37

@pradal

Description

@pradal

Provide an example of an header of a source file in an OpenAlea package

# -*- coding: latin-1 -*-

"""
    This script allows to run XXX over one scenario or a list of scenarios, using a specific set of parameters and
    options, which are specified in an input file.

    :copyright: see AUTHORS.
    :license: see LICENSE for details.
"""

or

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

"""
    XXX.scenarios
    ~~~~~~~~~~~~~
    The module :mod:`XXX.scenarios` is the front-end to run the XXX model.

    :copyright: see AUTHORS.

    :license: see LICENSE for details.

"""

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions