Updated documentation for directoryParsing

api/ECNQueue.py

@@ -322,20 +322,25 @@ def __parseSections(self) -> list:
 	def __directoryParsing(self, directoryStartLine: int) -> dict:
 		"""Returns a dictionary with directory information
 
-		Returns: dictionary: 
-				"type": "directoryInformation"
-				"Name": name,
-		    	"Login": login,
-				"Computer": computer,
-				"Location": location,
-				"Email": email,
-				"Phone": phone,
-				"Office": office,
-				"UNIX Dir": unix_dir,
-				"Zero Dir": zero_dir,
-				"User ECNDB": user_ecndb,
-				"Host ECNDB": host_ecdbn,
-				"Subject": subject
+		Example:
+			Name: Nestor Fabian Rodriguez Buitrago
+       		Login: rodri563
+   			Computer: ce-205-38 (128.46.205.67)
+    		Location: HAMP G230
+       		Email: rodri563@purdue.edu
+       		Phone: 7654766893
+      		Office: HAMP G230
+    		UNIX Dir: /home/bridge/b/rodri563
+    		Zero Dir: U=\\bridge.ecn.purdue.edu\rodri563
+  			User ECNDB: http://eng.purdue.edu/jump/2e8399a
+  			Host ECNDB: http://eng.purdue.edu/jump/2e83999    
+	    	Subject: Autocad installation
+
+		Args:
+			directoryStartLine (int): line number within the item that the directory starts on
+
+		Returns:
+			dict: dictionary that splits each line within the directory into a key and a value
 		"""
 		directoryInformation = {"type": "directory_information"}
 
@@ -443,10 +448,6 @@ def __assignmentParsing(self, contentStart: int) -> list:
 				},
 			]
 		"""
-		#Returns a list with assignment information dictionaries
-
-		#Returns:
-
 		assignmentList =[]
 
 		# Assignment Information