Add functions description

Add python documentation
2019-02-26 17:51:53 -05:00
parent 1b4d729e87
commit 46a3a02b2a
3 changed files with 56 additions and 0 deletions
--- a/pcbdevice/gcode/GcodeBuilder.py
+++ b/pcbdevice/gcode/GcodeBuilder.py
@@ -1,4 +1,12 @@
 def listToGCode(listIndex, pHeight, pWidth):
+	"""
+	Convert a list of matrix coordinate in a list of GCode commands
+	
+	:param listIndex: List of coordinate
+	:param pHeight: Pixel height in mm
+	:param pWidth: Pixel width in mm
+	:return: List of all the GCode commands
+	"""
 	gcodeCommand = []
 	toolUp = True