-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcodingGuidelines.py
108 lines (96 loc) · 3.57 KB
/
codingGuidelines.py
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
"""
INFORMATION BLOCK -
This is the Information Block. Copy as it is for every new file being created.
Further Updations must be entered by the LAST MODIFICATION sub block.
Below is given along with placement example.
"""
# import <Library X>
# import <Library X>
# import <Library X>
# /|\
# |
# |
# After the Import
# |
# |
# |
################################################################################################
# INFORMATION
#
# File Name : <fileName>.py
# Developer : <Full Name>
# Call Sign : <Designated Call Sign>
# First Stable Build : <Date as DAY MONTH(Word) YEAR>
# Use Case : <Use Case Description>
#
# Type : <Type of usage like func, class, main, support, etc>
# Inputs : <Inputs and Type>
#
# Output : <Outputs and Type>
# Description : <Brief File Description>
# <Brief File Description>
# <Brief File Description>
# <Brief File Description>
#
#------------------------------------------------------------------
# LAST MODIFICATION
# Developer : <Full Name>
# Call Sign : <Designated Call Sign>
# Date of Modification : <Date as DAY MONTH(Word) YEAR>
#
# Description : <Brief File Description>
# <Brief File Description>
# <Brief File Description>
# <Brief File Description>
#------------------------------------------------------------------
#
#------------------------------------------------------------------
# LAST MODIFICATION
# Developer : <Full Name>
# Call Sign : <Designated Call Sign>
# Date of Modification : <Date as DAY MONTH(Word) YEAR>
#
# Description : <Brief File Description>
# <Brief File Description>
# <Brief File Description>
# <Brief File Description>
#------------------------------------------------------------------
#
################################################################################################
# |
# |
# |
# Before any Initialization/Declaration
# |
# |
# \|/
# def function(input 1, input 2, input 3,...)
"""
CODE MODULE BLOCK -
This is the Code Module Block. Copy as it is for every new Code Module being created.
Every Code Module Creation/Updations must be tagged in the LAST MODIFICATION sub block.
Below is given along with placement example.
"""
###----------------------------------------------------------------------
# <CODE_MODULE_NAME>()
# Inputs : <Each Input described>
#
# Output : <Each Output described>
# Description : <Brief description of Code Module>
# <Brief description of Code Module>
# <Brief description of Code Module>
# <Brief description of Code Module>
###----------------------------------------------------------------------
# /|\
# |
# |
#Right Before that Module Declaration
# |
# |
# |
# def function(input 1, input 2, input 3,...)
# log_width = 30
# message_padding = (log_width - len(message)) // 2
# print(f"{'=' * log_width}")
# print(f"{'=' * message_padding}{message}{'=' * message_padding}")
# print(f"{'=' * log_width}")