MCSim_python/Programming instructions.txt at main · NTNU-MCS/MCSim_python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
## Programming instructions.

Please use the PEP 8 Style guide for good programming practice, found here:
https://www.python.org/dev/peps/pep-0008/


Each script or module should contain in its header the following information:

# ----------------------------------------------------------------------------
# This code is part of the MCSim_python toolbox and repository.
# Created By: name_of_the_creator
# Created Date: year-month-date
# Revised: <date>	<developer> <description>
#          <date>	<developer> <description>
# Tested:  <date> <describe to what degree the code has been tested;
#                   unit-testing, etc.>
#
# Copyright (C) 202x: <organization>, <place>
# Licensed under GPL-3.0-or-later
# ---------------------------------------------------------------------------
"""
Short description of module
Details about the module and for what purpose it was built for
"""
# ---------------------------------------------------------------------------
# Imports/dependencies
# ---------------------------------------------------------------------------


Each function within a module should be in the following format:

def function(arg1,arg2):
    """ <description>
       Input
           arg: <description>
       Output
           out1: <description>
           out2: <description>
    """
    # Created: <date>	<developer> <short description>
    # Tested: <date>	<developer> <short description>

    return out1, out2


NB: the text inside triple quotes appears as information about module/function
when calling them from the terminal. Trailing whitespace at end of line
indicates line break, and is important for formatting.