Apply 4 suggestion(s) to 4 file(s)

src/simudator/core/module.py

@@ -117,10 +117,18 @@ class Module:
         print(self.name)
 
     def _helper_save_state_to_file(self, file_path: str, content: str) -> bool:
-        """
-        Tries to save the content to a given file.
-
-        Returns true on success and false otherwise.
+        """Save the given content to a given file.
+
+        Parameters
+        ----------
+        file_path : str
+            Path to file to save to.
+        content : str    
+            Content to save to file.
+
+        Returns
+        -------
+        ``True`` on success, ``False`` otherwise.
         """
         try:
             with open(file_path, "a") as file:

src/simudator/processor/mia/modules/alu.py

@@ -67,7 +67,8 @@ class ALU(Module):
         pass
 
     def save_state_to_file(self, file_path: str) -> bool:
-        """
+        """Do nothing.
+
         The alu is state-less.
         """
         return True

src/simudator/processor/mia/modules/bus.py

@@ -70,7 +70,8 @@ class Bus(Module):
         pass
 
     def save_state_to_file(self, file_path: str) -> bool:
-        """
+        """Do nothing.
+
         The bus is state-less.
         """
         return True

src/simudator/processor/mia/modules/ir.py

@@ -129,9 +129,6 @@ class IR(Module, MiaBusConnector):
         )
 
     def save_state_to_file(self, file_path: str) -> bool:
-        """
-        Tries to save the modules state to a given file.
-        """
         content = self.name + ":\n"
         content += "Instruction: " + hex(self.instruction)[2:] + "\n\n"
         return super()._helper_save_state_to_file(file_path, content)