Documentation fixes

Author: henricasanova

wrench/compute_service.py

@@ -19,6 +19,7 @@ class ComputeService(SimulationItem):
     def __init__(self, simulation, name: str) -> None:
         """
         Constructor
+
         :param simulation: simulation object
         :type simulation
         :param name: Compute service name
@@ -28,28 +29,35 @@ def __init__(self, simulation, name: str) -> None:
 
     def supports_compound_jobs(self) -> bool:
         """
-        Returns true if the service supports compound jobs.
-        :return:
+        Determines whether the compute service supports compound jobs.
+
+        :return: True if compound jobs are supported, false otherwise
+        :rtype: bool
         """
         return self.simulation._supports_compound_jobs(self.name)
 
     def supports_pilot_jobs(self) -> bool:
         """
-        Returns true if the service supports pilot jobs.
-        :return:
+        Determines whether the compute service supports pilot jobs.
+
+        :return: True if pilot jobs are supported, false otherwise
+        :rtype: bool
         """
         return self.simulation._supports_pilot_jobs(self.name)
 
     def supports_standard_jobs(self) -> bool:
         """
-        Returns true if the service supports pilot jobs.
-        :return:
+        Determines whether the compute service supports standard jobs.
+
+        :return: True if standard jobs are supported, false otherwise
+        :rtype: bool
         """
         return self.simulation._supports_standard_jobs(self.name)
 
     def __str__(self) -> str:
         """
         :return: String representation of a compute service
+
         :rtype: str
         """
         s = f"Compute Service {self.name}"

wrench/virtual_machine.py

@@ -58,18 +58,27 @@ def shutdown(self) -> None:
     def is_running(self) -> bool:
         """
         Determines whether a virtual machine is running.
+
+        :return: True if the virtual machine is running, false otherwise
+        :rtype: bool
         """
         return self.simulation._is_vm_running(self.cloud_compute_service_name, self.name)
 
     def is_suspended(self) -> bool:
         """
         Determines whether a virtual machine is suspended.
+
+        :return: True if the virtual machine is suspended, false otherwise
+        :rtype: bool
         """
         return self.simulation._is_vm_suspended(self.cloud_compute_service_name, self.name)
 
     def is_down(self) -> bool:
         """
         Determines whether a virtual machine is down.
+
+        :return: True if the virtual machine is down, false otherwise
+        :rtype: bool
         """
         return self.simulation._is_vm_down(self.cloud_compute_service_name, self.name)