Add functions description

Add python documentation
This commit is contained in:
Marc-Antoine Lafreniere
2019-02-26 17:51:53 -05:00
parent 1b4d729e87
commit 46a3a02b2a
3 changed files with 56 additions and 0 deletions

View File

@@ -1,4 +1,10 @@
def readIntFile(filePath):
"""
Read a matrix file
:param filePath: File path to read from
:return: The matrix in int
"""
completeFile = []
file = open(filePath, 'r')
lines = file.readlines()
@@ -14,6 +20,12 @@ def readIntFile(filePath):
return completeFile
def readStringFile(filePath):
"""
Read all lines of a file
:param filePath: File path to read from
:return: Array of all lines in the file
"""
file = open(filePath, 'r')
lines = file.readlines()
file.close()