From 4f73437a33ca62304206ac0ce3127da3219a4c01 Mon Sep 17 00:00:00 2001
From: rabii-chaarani <rabii.chaarani@monash.edu>
Date: Wed, 10 Jul 2024 13:34:12 +0930
Subject: [PATCH] docs: add docstrings to the input module

---
 LoopDataConverter/input/input_data.py | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/LoopDataConverter/input/input_data.py b/LoopDataConverter/input/input_data.py
index 2fa7cdc..69f504a 100644
--- a/LoopDataConverter/input/input_data.py
+++ b/LoopDataConverter/input/input_data.py
@@ -5,6 +5,15 @@
 
 @dataclass
 class InputData:
+    """ Class to store input data for the loop data converter
+    
+    Attributes:
+    geology: Datatype.GEOLOGY = None 
+    structure: Datatype.STRUCTURE = None
+    fault: Datatype.FAULT = None
+    fold: Datatype.FOLD = None
+    
+    """
     geology: Datatype.GEOLOGY = None
     structure: Datatype.STRUCTURE = None
     fault: Datatype.FAULT = None
@@ -12,6 +21,14 @@ class InputData:
 
 
     def __getitem__(self, datatype: Datatype):
+        """ Method to get the the file directory of a datatype
+
+        Parameters:
+            datatype (Datatype): The datatype to get the file directory of
+
+        Returns:
+            The file directory of the datatype
+        """
 
         return self.__dict__[datatype]